Biometria Nativa Plugin Capacitor

Utilizzo di @capgo/capacitor-native-biometric

Questo plugin dà accesso alle API biometriche native per Android e iOS.

Installa

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

bunx cap sync copia i code nativi del plugin nei tuoi progetti nativi. Eseguilo di nuovo dopo ogni aggiornamento del plugin.

Importa

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

API in breve

Metodo	Descrizione
isAvailable	Verifica se l'hardware per l'autenticazione biometrica è disponibile.
verifyIdentity	Richiede all'utente l'autenticazione tramite biometria.
getCredentials	Recupera le credenziali salvate per un determinato server.
setCredentials	Salva le credenziali fornite per un determinato server.
deleteCredentials	Elimina le credenziali salvate per un determinato server.
getSecureCredentials	Recupera le credenziali salvate per un server, richiedendo l'autenticazione biometrica. Le credenziali devono essere state salvate con accessControl impostato su BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
isCredentialsSaved	Verifica se le credenziali sono già salvate per un determinato server.
setData	Salva un valore stringa arbitrario sotto la chiave specificata. I valori sono criptati a riposo tramite il secure storage della piattaforma (Android Keystore + SharedPreferences, iOS Keychain).
getData	Recupera un valore precedentemente salvato per la chiave specificata. Restituisce solo valori salvati senza biometria. accessControl.
getSecureData	Recupera un valore protetto da biometria per la chiave specificata. Il valore deve essere stato salvato con accessControl impostato su BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
deleteData	Elimina il valore memorizzato per la chiave specificata (protetta e non).
isDataSaved	Verifica se è già presente un valore per la chiave specificata.

Esempi

isAvailable()

Controlla se l'hardware per l'autenticazione biometrica è disponibile.

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

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

verifyIdentity()

Richiede all'utente l'autenticazione tramite biometria.

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

await NativeBiometric.verifyIdentity();

getCredentials()

Recupera le credenziali memorizzate per un determinato server.

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()

Memorizza le credenziali fornite per un determinato server.

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

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

deleteCredentials()

Elimina le credenziali memorizzate per un determinato server.

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

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

getSecureCredentials()

Recupera le credenziali memorizzate per un server, richiedendo l'autenticazione biometrica. Le credenziali devono essere state salvate con accessControl impostato su BIOMETRY_CURRENT_SET o 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.

La tabella sopra elenca i 12 metodi principali. Gli helper per listener e versione e il contratto completo di ogni metodo sono documentati in repository GitHub.

Ascolta gli eventi

addListener restituisce un handle. Chiama handle.remove() quando la schermata viene smontata.

Riferimento completo

• repository GitHub
• Documentazione
• riferimento API

Continua da Usare @capgo/capacitor-native-biometric

Se stai usando Utilizzo di @capgo/capacitor-native-biometric per pianificare i flussi di autenticazione e account, collegandolo a @capgo/capacitor-native-biometric per i dettagli di implementazione in @capgo/capacitor-native-biometric, Per iniziare per i dettagli di implementazione nella guida introduttiva, @capgo/capacitor-social-login per i dettagli di implementazione in @capgo/capacitor-social-login, @capgo/capacitor-passkey per i dettagli di implementazione in @capgo/capacitor-passkey, e Autenticazione a due fattori per i dettagli sull'implementazione dell'autenticazione a due fattori.