Langsung ke konten utama
@capgo/capacitor-native-biometric Auth & Keamanan Open source

Biometrik Native plugin Capacitor

Autentikasi aman menggunakan Face ID, Touch ID, dan API biometrik Android

Instal

bun add @capgo/capacitor-native-biometric bunx cap sync
npm, pnpm atau yarn
  • npm install @capgo/capacitor-native-biometric
  • pnpm add @capgo/capacitor-native-biometric
  • yarn add @capgo/capacitor-native-biometric

Panduan

Cara menggunakan Native Biometric di Capacitor

Tes di perangkat

Download aplikasi Capgo, lalu scan QR code.

Pratinjau QR plugin Native Biometric code

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.

FAQ

FAQ plugin Native Biometric

Bagaimana cara menginstal plugin Native Biometric di aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-native-biometric" (atau "npm install @capgo/capacitor-native-biometric"), lalu jalankan "bunx cap sync" agar proyek iOS dan Android mengambil code native. Impor dari "@capgo/capacitor-native-biometric" di code aplikasi Anda.

Apakah @capgo/capacitor-native-biometric bekerja dengan React, Vue, dan Angular?

Ya. Native Biometric adalah paket Capacitor, jadi bekerja dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte, dan JavaScript vanilla.

Versi Capacitor mana yang didukung @capgo/capacitor-native-biometric?

Plugin Capgo mengikuti versi mayor Capacitor: gunakan versi mayor plugin yang sesuai dengan versi mayor Capacitor Anda (contoh: plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub mencantumkan versi yang masih di-maintain.

Apakah @capgo/capacitor-native-biometric gratis dan open source?

Ya. code sumber tersedia untuk publik di GitHub di https://github.com/Cap-go/capacitor-native-biometric/ dan paketnya gratis diinstal dari npm. Laporan bug dan pull request sangat diterima.

Bisakah saya memperbarui code yang menggunakan Native Biometric tanpa review App Store?

Instalasi atau upgrade plugin akan mengubah native code, jadi butuh build store baru. Setelah itu, perubahan JavaScript, HTML, dan CSS yang memanggil plugin bisa langsung dikirim lewat live updates Capgo.

Rilis perubahan Native Biometric tanpa menunggu review aplikasi

Setelah plugin ada di build store Anda, live updates Capgo akan mengirim perubahan JavaScript, HTML, dan CSS ke pengguna dalam hitungan menit.

Mulai dengan Capgo