Implementare il ripristino delle credenziali con Credential Manager

Questa pagina descrive come creare, accedere e eliminare una chiave di ripristino.

Compatibilità delle versioni

La funzionalità Ripristina credenziali di Credential Manager funziona su dispositivi con Android 9 (livello API 28) e versioni successive, Google Play Services (GMS) core versione 24220000 o successive e versione 1.5.0 o successive della libreria androidx.credentials.

Prerequisiti

Configura un server del componente simile a quello per le passkey. Se hai già configurato un server per gestire l'autenticazione con le passkey, utilizza la stessa implementazione lato server per le chiavi di ripristino.

Dipendenze

Aggiungi le seguenti dipendenze al file build.gradle del modulo dell'app:

Kotlin

dependencies {
    implementation("androidx.credentials:credentials:1.7.0-alpha02")
    implementation("androidx.credentials:credentials-play-services-auth:1.7.0-alpha02")
}

Trendy

dependencies {
    implementation "androidx.credentials:credentials:1.7.0-alpha02"
    implementation "androidx.credentials:credentials-play-services-auth:1.7.0-alpha02"
}

Restore Credentials è disponibile a partire dalla versione 1.5.0 e successive della libreria androidx.credentials. Tuttavia, ti consigliamo di utilizzare le versioni stabili più recenti delle dipendenze, se possibile.

Panoramica

  1. Crea una chiave di ripristino: per creare una chiave di ripristino, completa i seguenti passaggi:
    1. Instantiate Credential Manager: crea un oggetto CredentialManager.
    2. Ottieni le opzioni di creazione delle credenziali dal server dell'app: invia all'app client i dettagli necessari per creare la chiave di ripristino dal server dell'app.
    3. Crea la chiave di ripristino: crea una chiave di ripristino per l'account dell'utente se ha eseguito l'accesso alla tua app.
    4. Gestisci la risposta alla creazione delle credenziali: invia le credenziali dalla tua app client al server dell'app per l'elaborazione e gestisci eventuali eccezioni.
  2. Accedi con una chiave di ripristino: per accedere con una chiave di ripristino, completa i seguenti passaggi:
    1. Ottieni le opzioni di recupero delle credenziali dal server dell'app: invia all'app client i dettagli necessari per recuperare la chiave di ripristino dal server dell'app.
    2. Ottieni la chiave di ripristino: richiedi la chiave di ripristino a Gestione credenziali quando l'utente configura un nuovo dispositivo. In questo modo l'utente può accedere senza ulteriori input.
    3. Gestisci la risposta al recupero delle credenziali: invia la chiave di ripristino dall'app client al server dell'app per consentire all'utente di accedere.
  3. Elimina una chiave di ripristino.

Crea una chiave di ripristino

La tua app deve coprire tutti i casi di accesso di un utente per garantire che gli utenti attivi abbiano una chiave di ripristino creata. Crea la chiave di ripristino nei seguenti scenari:

  • Se l'utente ha eseguito l'accesso e non è già stata creata una chiave di ripristino (ad esempio nel metodo onCreate per Activity principale).
  • Quando l'utente esegue l'accesso o completa un nuovo flusso di registrazione dell'account.

Per ottimizzare le prestazioni ed evitare il sovraccarico di creare o controllare una credenziale di ripristino a ogni accesso, imposta un flag boolean o un timestamp di creazione delle credenziali nell'archivio locale, ad esempio has_synced_restore_credential, per monitorare se la chiave è già stata creata.

Crea un'istanza di Gestore delle credenziali

Utilizza il contesto dell'attività della tua app per creare un'istanza di un oggetto CredentialManager.

// Use your app or activity context to instantiate a client instance of
// CredentialManager.
private val credentialManager = CredentialManager.create(context)

Recuperare le opzioni di creazione delle credenziali dal server dell'app

Utilizza una libreria conforme a FIDO nel server dell'app per inviare all'app client le informazioni necessarie per creare le credenziali di ripristino, ad esempio informazioni sull'utente, sull'app e proprietà di configurazione aggiuntive. Per saperne di più sull'implementazione lato server, consulta la Guida lato server.

Crea la chiave di ripristino

Dopo aver analizzato le opzioni di creazione della chiave pubblica inviate dal server, crea una chiave di ripristino racchiudendo queste opzioni in un oggetto CreateRestoreCredentialRequest e chiamando il metodo createCredential() con l'oggetto CredentialManager.

// createRestoreRequest contains the details sent by the server 
val response = credentialManager.createCredential(context, createRestoreRequest)

Punti chiave sul codice

  • L'oggetto CreateRestoreCredentialRequest contiene i seguenti campi:

    • requestJson: le opzioni di creazione delle credenziali inviate dal server delle app nel formato dell'API Web Authentication per PublicKeyCredentialCreationOptionsJSON.

    • isCloudBackupEnabled: campo Boolean per determinare se la chiave di ripristino deve essere sottoposta a backup nel cloud. Per impostazione predefinita, questo flag è true. Questo campo ha i seguenti valori:

      • true: (consigliato) questo valore consente il backup delle chiavi di ripristino sul cloud se l'utente ha attivato il backup di Google e la crittografia end-to-end, ad esempio un blocco schermo.
      • false: questo valore salva la chiave localmente e non nel cloud. La chiave non è disponibile sul nuovo dispositivo se l'utente sceglie di eseguire il ripristino dal cloud.

Gestire la risposta di creazione delle credenziali

L'API Credential Manager restituisce una risposta di tipo CreateRestoreCredentialResponse. Questa risposta contiene la risposta alla registrazione delle credenziali della chiave pubblica in formato JSON.

Invia la chiave pubblica dalla tua app al server della relying party. Questa chiave pubblica è simile a quella generata quando crei una passkey. Lo stesso codice che gestisce la creazione delle passkey sul server può gestire anche la creazione della chiave di ripristino. Per ulteriori informazioni sull'implementazione lato server, consulta la guida per le passkey.

Durante la procedura di creazione della chiave di ripristino, gestisci queste eccezioni:

  • CreateRestoreCredentialDomException: questa eccezione si verifica se requestJson non è valido e non segue il formato WebAuthn per PublicKeyCredentialCreationOptionsJSON.
  • E2eeUnavailableException: questa eccezione si verifica se isCloudBackupEnabled è true, ma il dispositivo dell'utente non dispone di backup dei dati o crittografia end-to-end, ad esempio un blocco schermo.
    Per assicurarti che le Restore Credentials vengano create in tutti i casi, devi gestire E2eeUnavailableException in modo esplicito chiamando createCredential con isCloudBackupEnabled impostato su true. Se viene generato E2eeUnavailableException, intercetta e chiama di nuovo createCredential con isCloudBackupEnabled impostato su false.
  • IllegalArgumentException: questa eccezione si verifica se createRestoreRequest è vuoto o non è un JSON valido oppure se non ha un user.id valido che sia conforme alle specifiche di WebAuthn.

Accedere con una chiave di ripristino

Utilizza Restore Credentials per accedere in modo invisibile all'utente durante la procedura di configurazione del dispositivo.

Recuperare le opzioni di recupero delle credenziali dal server dell'app

Invia all'app client le opzioni necessarie per ottenere la chiave di ripristino dal server. Per indicazioni simili per questo passaggio, consulta Accedere con una passkey. Per saperne di più sull'implementazione lato server, consulta la guida all'autenticazione lato server.

Recuperare la chiave di ripristino

Per ottenere la chiave di ripristino sul nuovo dispositivo, chiama il metodo getCredential() sull'oggetto CredentialManager.

È consigliabile recuperare la chiave di ripristino in entrambi gli scenari seguenti:

  • Al primo avvio dell'app sul dispositivo. Il ripristino delle credenziali in questo scenario è indipendente dal ripristino dei dati dell'app.
  • Se il backup e il ripristino dei dati delle app sono attivi, recupera la chiave di ripristino immediatamente dopo il ripristino dei dati delle app. Utilizza BackupAgent per configurare il backup della tua app e assicurati di completare la funzionalità getCredential all'interno del callback onRestoreFinished. Non utilizzare il metodo onRestore perché viene chiamato solo per i backup coppia chiave-valore, mentre onRestoreFinished viene chiamato in modo affidabile per qualsiasi tipo di ripristino del backup. In questo modo si evitano potenziali ritardi quando gli utenti aprono il nuovo dispositivo per la prima volta e si consente loro di interagire con l'app senza doverla aprire. Ad esempio, l'app può inviare notifiche all'utente prima che la apra per la prima volta sul nuovo dispositivo, il che è particolarmente importante per le app di messaggistica o comunicazione.

Se crei un nuovo BackupAgent e in precedenza avevi attivato il backup con allowBackup="true", imposta il valore booleano android:fullBackupOnly="true" nel manifest della tua app. In questo modo, il comportamento di backup e ripristino dell'app viene mantenuto.

// Fetch the options required to get the restore key
val authenticationJson = fetchAuthenticationJson()

// Create the GetRestoreCredentialRequest object
val options = GetRestoreCredentialOption(authenticationJson)
val getRequest = GetCredentialRequest(listOf(options))

val response = credentialManager.getCredential(context, getRequest)

// Type-check and extract the restore credential
val credential = response.credential as RestoreCredential

Le API di gestione delle credenziali restituiscono una risposta di tipo GetCredentialResponse. La credenziale contenuta in questa risposta è esplicitamente di tipo RestoreCredential, che contiene la chiave pubblica.

Gestire la risposta di accesso

Invia la chiave pubblica dall'app al server della relying party, che può essere utilizzata per accedere all'utente. Sul lato server, questa azione è simile all'accesso con una passkey. Lo stesso codice che gestisce l'accesso con le passkey sul server può gestire anche gli accessi con le chiavi di recupero. Per maggiori informazioni sull'implementazione lato server delle passkey, vedi Accedere con una passkey.

Elimina la chiave di ripristino

Gestore delle credenziali è stateless e non è a conoscenza dell'attività utente, quindi non elimina automaticamente le chiavi di ripristino dopo l'uso. Per eliminare una chiave di ripristino, chiama il metodo clearCredentialState. Per motivi di sicurezza, elimina la chiave ogni volta che un utente esce. In questo modo, la volta successiva che l'utente aprirà l'app sullo stesso dispositivo, verrà disconnesso e gli verrà chiesto di accedere di nuovo.

La disinstallazione di un'app viene interpretata come intenzione di eliminare la chiave di ripristino corrispondente dal dispositivo, in modo simile all'intenzione dell'utente quando esegue la disconnessione.

Le chiavi di ripristino vengono rimosse solo nelle seguenti situazioni:

  • Azioni a livello di sistema: gli utenti disinstallano l'app o cancellano i relativi dati.
  • Chiamate a livello di app: elimina la chiave a livello di programmazione chiamando clearCredentialState() quando gestisci la disconnessione dell'utente nel codice della tua app.

Quando l'utente esce dalla tua app, chiama il metodo clearCredentialState() sull'oggetto CredentialManager.

// Create a ClearCredentialStateRequest object
val clearRequest = ClearCredentialStateRequest(TYPE_CLEAR_RESTORE_CREDENTIAL)

// When the user logs out, delete the restore key
val response = credentialManager.clearCredentialState(clearRequest)