Lebih lanjut ke konten utama
@capgo/capacitor-native-biometric Keamanan & Autentikasi Terbuka sumber

Biometrik Native Plugin Capacitor

Menggunakan wajah, Touch ID, dan Android biometrik untuk autentikasi yang lebih aman

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 Biometrik Asli di Capacitor

Test di perangkat

Unduh aplikasi Capgo, kemudian scan kode QR code.

Tautan QR pratinjau plugin Biometrik Asli code

Menggunakan @capgo/capacitor-biometrik-asli

Plugin ini memberikan akses ke API biometrik asli untuk android dan iOS.

Pasang

bun add @capgo/capacitor-native-biometric
bunx cap sync

bunx cap sync Menggandakan plugin native code ke proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.

Import

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

API secara singkat

Metode Deskripsi
isAvailable Mengatur apakah perangkat autentikasi biometrik tersedia.
verifyIdentity Mengajak pengguna untuk mengautentikasi dengan biometrik.
getCredentials Mengambil kreditensi yang disimpan untuk server tertentu.
setCredentials Menyimpan kreditensi yang diberikan untuk server tertentu.
deleteCredentials Menghapus kreditensi yang disimpan untuk server tertentu.
getSecureCredentials Mengambil kreditensi yang disimpan untuk server tertentu, memerlukan autentikasi biometrik. Kreditensi harus disimpan dengan aksesControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
isCredentialsSaved Mengatur apakah kreditensi sudah disimpan untuk server tertentu.
setData Menyimpan nilai string apa pun di bawah kunci yang diberikan. Nilai-nilai disimpan dengan cara dienkripsi menggunakan backend penyimpanan yang aman (Android Keystore + SharedPreferences, iOS Keychain).
getData Mengambil nilai yang telah disimpan sebelumnya untuk kunci yang diberikan. Hanya mengembalikan nilai-nilai yang disimpan tanpa biometrik. accessControl.
getSecureData Mengambil nilai yang dilindungi biometrik untuk kunci yang diberikan. Nilai tersebut harus telah disimpan dengan accessControl Ditetapkan ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
deleteData Menghapus nilai yang disimpan untuk kunci yang diberikan (lindungi dan tidak dilindungi).
isDataSaved Mengatur apakah nilai sudah disimpan untuk kunci yang diberikan.

Contoh

isAvailable()

Mengatur apakah perangkat autentikasi biometrik sudah tersedia.

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

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

verifyIdentity()

Mengajak pengguna untuk melakukan autentikasi dengan biometrik.

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

await NativeBiometric.verifyIdentity();

getCredentials()

Mengambil kredit yang disimpan untuk server yang diberikan.

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 kredit yang diberikan untuk server yang diberikan.

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

await NativeBiometric.setCredentials({
  username: 'username',
  password: 'password',
  server: 'example.com',
});

deleteCredentials()

Menghapus kredit yang disimpan untuk server yang diberikan.

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

await NativeBiometric.deleteCredentials({ server: 'example.com' });

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.

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.

Daftar tabel di atas mencantumkan 12 metode inti. Pembantu pendengar dan versi, serta kontrak penuh dari setiap metode, terdokumentasi di repository GitHub.

Dengarkan kejadian

addListener mengembalikan sebuah handle. Panggil handle.remove() ketika layar dihapus.

Referensi lengkap

Teruskan dari Menggunakan @capgo/capacitor-native-biometric

Jika Anda menggunakan Gunakan @capgo/capacitor-native-biometric untuk merencanakan alur autentikasi dan akun, hubungkannya dengan @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, Mulai Menggunakan untuk detail implementasi di Mulai, @capgo/capacitor-login Sosial 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

Teruskan dari Menggunakan @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-biometrik native

Bagaimana cara saya menginstal plugin Biometrik Nativ di sebuah aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-native-biometric" (atau "npm install @capgo/capacitor-native-biometric"), kemudian jalankan "bunx cap sync" agar proyek iOS dan Android dapat menangkap native code. Import dari "@capgo/capacitor-native-biometric" di aplikasi code.

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

Ya. Biometrik Nativ adalah sebuah paket Capacitor, sehingga berfungsi dengan semua framework web yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte dan JavaScript biasa.

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

Capgo plugin mengikuti versi utama Capacitor: gunakan versi plugin utama yang sesuai dengan versi utama Capacitor (misalnya plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub menampilkan versi yang dipertahankan.

Apakah @capgo/capacitor-native-biometric gratis dan terbuka sumber?

Ya. Sumber code tersedia secara publik di GitHub di https://github.com/Cap-go/capacitor-native-biometric/ dan paketnya dapat diinstal secara gratis dari npm. Laporan bug dan permintaan pull selalu welcome.

Dapatkah saya memperbarui code yang menggunakan Biometrik Nativ tanpa melalui tinjauan App Store?

Menginstal atau mengupgrade plugin mengubah native code, sehingga memerlukan build aplikasi baru. Setelah itu, perubahan JavaScript, HTML dan CSS yang memanggil plugin dapat dikirimkan secara langsung dengan Capgo live updates.

Kirim Perubahan Biometrik Asli tanpa Menunggu Ulasan Aplikasi

Setelah plugin masuk ke dalam toko Anda, Capgo pembaruan hidup memindahkan perubahan JavaScript, HTML, dan CSS Anda ke pengguna dalam menit.

Mulai dengan Capgo