Biometrik Native plugin Capacitor

Menggunakan @capgo/capacitor-native-biometric

Plugin ini memberi akses ke API biometrik native untuk Android dan iOS.

Instal

bun add @capgo/capacitor-native-biometric
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 untuk autentikasi menggunakan 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 dengan autentikasi biometrik. Kredensial harus disimpan dengan accessControl bernilai BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
isCredentialsSaved	Mengecek apakah kredensial sudah tersimpan untuk server tertentu.
setData	Menyimpan nilai string arbitrer di bawah key yang diberikan. Nilai dienkripsi saat istirahat menggunakan secure storage platform (Android Keystore + SharedPreferences, iOS Keychain).
getData	Mengambil nilai yang sebelumnya tersimpan untuk key tersebut. Hanya mengembalikan nilai yang disimpan tanpa biometrik accessControl.
getSecureData	Mengambil nilai yang dilindungi biometrik untuk key tersebut. Nilai harus sudah disimpan dengan accessControl set ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
deleteData	Menghapus nilai yang tersimpan untuk key tertentu (terlindungi maupun tidak).
isDataSaved	Memeriksa apakah nilai sudah tersimpan untuk key tertentu.

Contoh

isAvailable()

Memeriksa ketersediaan hardware autentikasi biometrik.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.isAvailable();
console.log(result);

verifyIdentity()

Meminta pengguna untuk melakukan autentikasi 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 yang tersimpan untuk server tertentu dengan autentikasi biometrik. Kredensial harus disimpan dengan accessControl bernilai 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

• repositori GitHub
• Dokumentasi
• referensi API

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.