Saltare al contenuto principale
@capgo/capacitor-native-biometric Autenticazione & Sicurezza Sorgente aperta

Biometrico nativo Plugin Capacitor

Autenticazione sicura utilizzando Face ID, Touch ID e API biometriche Android

Installa

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

Guida

Come utilizzare Native Biometric in Capacitor

Testa sul dispositivo

Scarica l'app Capgo, poi scansione il codice QR code.

Visuale anteprima del plugin di biometria nativa QR code

Utilizza @capgo/capacitor-biometria-nativa

Questo plugin fornisce accesso alle API di biometria native per Android e iOS.

Installa

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

bunx cap sync copia il code nativo del plugin nei tuoi progetti nativi. Esegui nuovamente dopo ogni aggiornamento del plugin.

Importa

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

API in un colpo solo

Metodo Descrizione
isAvailable Verifica se l'hardware di autenticazione biometrica è disponibile.
verifyIdentity Sollecita l'utente a autenticarsi con i biometri.
getCredentials Recupera le credenziali memorizzate per un server specifico.
setCredentials Memorizza le credenziali fornite per un server specifico.
deleteCredentials Elimina le credenziali memorizzate per un server specifico.
getSecureCredentials Recupera le credenziali memorizzate per un server specifico, richiedendo l'autenticazione biometrica. Le credenziali devono essere state memorizzate con accessControl impostato su BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
isCredentialsSaved Verifica se le credenziali sono già salvate per un server specifico.
setData Memorizza un valore di stringa arbitrario sotto la chiave specificata. I valori sono crittografati in modo persistente utilizzando il backend di archiviazione sicuro della piattaforma (Android Keystore + SharedPreferences, iOS Keychain).
getData Ottiene un valore precedentemente memorizzato per la chiave specificata. Restituisce solo i valori memorizzati senza biometrico. accessControl.
getSecureData Ottiene un valore protetto da biometria per la chiave specificata. Il valore deve essere stato memorizzato con accessControl impostalo su BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
deleteData Elimina il valore memorizzato per la chiave specificata (protetto e non protetto).
isDataSaved Verifica se un valore è già stato salvato per la chiave specificata.

Esempi

isAvailable()

Verifica se sono disponibili dispositivi di autenticazione biometrica.

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

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

verifyIdentity()

Richiede all'utente di autenticarsi con i dati biometrici.

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

await NativeBiometric.verifyIdentity();

getCredentials()

Recupera le credenziali memorizzate per un server specifico.

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 specificate per un server specifico.

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

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

deleteCredentials()

Cancella le credenziali memorizzate per un server specifico.

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

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

getSecureCredentials()

Recupera le credenziali memorizzate per un server specifico, richiedendo l'autenticazione biometrica. Le credenziali devono essere state memorizzate 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.

I metodi elencati nella tabella sopra sono 12. I listener e gli aiuti di versione, nonché il contratto completo di ogni metodo, sono documentati nel repository GitHub.

Ascolta gli eventi

addListener restituisce un handle. Chiamalo handle.remove() quando lo schermo viene smontato.

Riferimento completo

Continua da Utilizzo di @capgo/capacitor-native-biometric

Se stai utilizzando Utilizzo di @capgo/capacitor-native-biometric per pianificare l'autenticazione e le flussi di account, connettilo con @capgo/capacitor-native-biometric per i dettagli di implementazione in @capgo/capacitor-native-biometric Getting Started per i dettagli di implementazione in Getting Started, @capgo/capacitor-login sociale per i dettagli di implementazione in @capgo/capacitor-login sociale, @capgo/capacitor-chiave passiva per i dettagli di implementazione in @capgo/capacitor-chiave passiva, e Autenticazione a due fattori per i dettagli di implementazione in Autenticazione a due fattori.

FAQ

Domande frequenti sul plugin di biometria nativa

Come posso installare il plugin di biometria nativa in un'app Capacitor?

Esegui "bun add @capgo/capacitor-native-biometric" (o "npm install @capgo/capacitor-native-biometric"), quindi esegui "bunx cap sync" affinché i progetti iOS e Android recuperino il code nativo. Importalo da "@capgo/capacitor-native-biometric" nella tua app code.

Funziona @capgo/capacitor-native-biometric con React, Vue e Angular?

Sì. Il plugin di biometria nativa è un pacchetto Capacitor, quindi funziona con qualsiasi framework web che esegue all'interno di Capacitor, compresi Ionic, React, Vue, Angular, Svelte e JavaScript puro.

Qual è la versione di Capacitor supportata da @capgo/capacitor-native-biometric?

Capgo plugin seguenti seguono la versione maggiore di Capacitor: utilizza la versione maggiore del plugin che corrisponde alla tua versione maggiore di Capacitor (ad esempio plugin v8 con Capacitor 8). La tabella di compatibilità nella GitHub README elenca le versioni mantenute.

È @capgo/capacitor-native-biometric gratuito e open source?

Sì. Il codice sorgente di code è pubblico su GitHub a https://github.com/Cap-go/capacitor-native-biometric/ e il pacchetto è gratuito per l'installazione da npm. I rapporti di bug e le richieste di pull sono graditi.

Posso aggiornare code che utilizza Native Biometric senza una revisione dell'App Store?

L'installazione o l'aggiornamento del plugin modifica il nativo code, quindi richiede una nuova costruzione del negozio. Dopo di che, le modifiche JavaScript, HTML e CSS che chiamano il plugin possono essere spediti immediatamente con Capgo aggiornamenti live.

Invia modifiche di Biometric Native senza attendere la revisione dell'app

Una volta che il plugin è nel tuo store build, Capgo le aggiornamenti live inviano le tue modifiche JavaScript, HTML e CSS agli utenti in pochi minuti.

Inizia con Capgo