Negozio di blocchi

Molti utenti gestiscono ancora le proprie credenziali durante la configurazione di un nuovo dispositivo Android. Questo processo manuale può diventare difficile e spesso comporta un'esperienza utente scadente. L'API Block Store, una libreria basata su Google Play Services, cerca di risolvere questo problema fornendo alle app un modo per salvare le credenziali utente senza la complessità o il rischio per la sicurezza associati al salvataggio delle password degli utenti.

L'API Block Store consente alla tua app di archiviare i dati che può recuperare in un secondo momento per autenticare nuovamente gli utenti su un nuovo dispositivo. Questo contribuisce a offrire un'esperienza più fluida all'utente, dal momento che non ha bisogno di vedere una schermata di accesso quando lancia l'app per la prima volta sul nuovo dispositivo.

L'utilizzo del Block Store offre diversi vantaggi, tra cui:

• Soluzione di archiviazione delle credenziali criptata per gli sviluppatori. Le credenziali vengono criptate end-to-end quando possibile.
• Salva i token invece dei nomi utente e delle password.
• Elimina l'attrito dai flussi di accesso.
• Risparmia agli utenti con la necessità di gestire password complesse.
• Google verifica l'identità dell'utente.

Nota: l'uso di Block Store non limita l'utente al tipo di credenziali utilizzabili. Gli utenti possono accedere con il nome utente e la password, con l'Account Google o con qualsiasi altro provider di identità federato e il negozio di Chrome funziona comunque.

Prima di iniziare

Per preparare l'app, completa i passaggi indicati nelle sezioni che seguono.

Configura la tua app

Nel file build.gradle a livello di progetto, includi il repository Maven di Google nelle sezioni buildscript e allprojects:

buildscript {
  repositories {
    google()
    mavenCentral()
  }
}

allprojects {
  repositories {
    google()
    mavenCentral()
  }
}

Aggiungi la dipendenza Google Play Services per l'API Block Store al file build Gradle del tuo modulo, che in genere è app/build.gradle:

dependencies {
  implementation 'com.google.android.gms:play-services-auth-blockstore:16.2.0'
}

Come funziona

Il blocco store consente agli sviluppatori di salvare e ripristinare array fino a 16 byte. In questo modo, puoi salvare informazioni importanti relative alla sessione utente corrente e offrire la flessibilità di salvarle come preferisci. Questi dati possono essere criptati end-to-end e l'infrastruttura che supporta Block Store si basa sull'infrastruttura Backup e ripristino.

Questa guida illustra il caso d'uso del salvataggio del token di un utente nel Block Store. I passaggi che seguono descrivono il funzionamento di un'app che utilizza il Blocco Store.

1. Durante il flusso di autenticazione della tua app o in un secondo momento, puoi memorizzare il token di autenticazione dell'utente nel Blocca negozio per recuperarlo in un secondo momento.
2. Il token verrà archiviato localmente e potrai anche eseguirne il backup sul cloud, se possibile con crittografia end-to-end.
3. I dati vengono trasferiti quando l'utente avvia un flusso di ripristino su un nuovo dispositivo.
4. Se l'utente ripristina l'app durante il flusso di ripristino, l'app potrà recuperare il token salvato dal Block Store sul nuovo dispositivo.

Salvataggio del token

Quando un utente accede alla tua app, puoi salvare nel Token Store il token di autenticazione generato per quell'utente. Puoi memorizzare questo token utilizzando un valore univoco di una coppia di chiavi con un massimo di 4 kB per voce. Per archiviare il token, chiama setBytes() e 'setKey(/android/reference/com/google/android/gms/auth/blockstore/StoreBytesData.Builder.html#setKey(java.lang.String)' su un'istanza di StoreBytesData.Builder per archiviare le credenziali dell'utente sul dispositivo di origine. Dopo averlo salvato con il Block Store, il token viene criptato e archiviato localmente sul dispositivo.

L'esempio seguente mostra come salvare il token di autenticazione sul dispositivo locale:

Java

  BlockstoreClient client = Blockstore.getClient(this);
  byte[] bytes1 = new byte[] { 1, 2, 3, 4 };  // Store one data block.
  String key1 = "com.example.app.key1";
  StoreBytesData storeRequest1 = StoreBytesData.Builder()
          .setBytes(bytes1)
          // Call this method to set the key value pair the data should be associated with.
          .setKeys(Arrays.asList(key1))
          .build();
  client.storeBytes(storeRequest1)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this)

  val bytes1 = byteArrayOf(1, 2, 3, 4) // Store one data block.
  val key1 = "com.example.app.key1"
  val storeRequest1 = StoreBytesData.Builder()
    .setBytes(bytes1) // Call this method to set the key value with which the data should be associated with.
    .setKeys(Arrays.asList(key1))
    .build()
  client.storeBytes(storeRequest1)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "Stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

Byte precedentemente archiviati senza chiave?

Se in precedenza hai utilizzato l'API StoreBytes() per salvare i dati, ti consigliamo di iniziare a salvare i tuoi token con una chiave. I dati salvati in precedenza mediante StoreBytes vengono salvati con la chiave BlockstoreClient.DEFAULT_BYTES_DATA_KEY.

Utilizza token predefinito

I dati salvati utilizzando StoreBytes senza una chiave utilizzano la chiave predefinita StorestoreClient.DEFAULT_BYTES_DATA_KEY.

Java

  BlockstoreClient client = Blockstore.getClient(this);
  // The default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  byte[] bytes = new byte[] { 9, 10 };
  StoreBytesData storeRequest = StoreBytesData.Builder()
          .setBytes(bytes)
          .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this);
  // the default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  val bytes = byteArrayOf(1, 2, 3, 4)
  val storeRequest = StoreBytesData.Builder()
    .setBytes(bytes)
    .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

Come vengono archiviati i dati sul dispositivo e chi può accedervi?

I dati sul dispositivo StoreStore vengono archiviati nella directory locale dei dati privati di Google Play Services. Nessun'altra app può accedere direttamente al file di dati. Possono accedere ai dati di StoreStore solo tramite l'API retrieveBytes() e un'app può recuperare solo i dati archiviati per se stessa. Google Play Services controlla sia il nome del pacchetto sia la firma.

Recupero del token in corso...

Successivamente, quando un utente esegue il flusso di ripristino su un nuovo dispositivo, Google Play Services verifica prima l'utente, quindi recupera i tuoi dati nel Store Store. L'utente ha già accettato di ripristinare i dati dell'app nell'ambito del flusso di ripristino, quindi non sono necessari altri consensi. Quando l'utente apre l'app, puoi richiedere il token nel Block Store chiamando retrieveBytes(). Il token recuperato può quindi essere utilizzato per mantenere l'accesso dell'utente sul nuovo dispositivo.

L'esempio seguente mostra come recuperare più token in base a chiavi specifiche.

Java

BlockstoreClient client = Blockstore.getClient(this);

// Retrieve data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to retrieve data stored without a key

List requestedKeys = Arrays.asList(key1, key2, key3); // Add keys to array
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(requestedKeys)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(requestedKeys)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

Recupero di tutti i token in corso...

Di seguito è riportato un esempio di come recuperare tutti i token salvati in BlockStore.

Java

BlockstoreClient client = Blockstore.getClient(this)

// Retrieve all data.
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setRetrieveAll(true)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setRetrieveAll(true)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

Ritiro di retrieveBytes().

L'API retrieveBytes() è deprecata. Per recuperare i byte, la chiave BlockstoreClient.DEFAULT_BYTES_DATA_KEY può essere utilizzata nell'istanza RetrieveBytesRequest per recuperare i tuoi dati salvati

Di seguito è riportato un esempio di come recuperare la chiave predefinita.

Java

BlockStoreClient client = Blockstore.getClient(this);
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
    .build();
client.retrieveBytes(retrieveRequest);

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
  .build()
client.retrieveBytes(retrieveRequest)

Eliminazione dei token

L'eliminazione dei token da BlockStore può essere necessaria per i seguenti motivi:

• L'utente esegue la procedura di disconnessione.
• Il token è stato revocato o non è valido.

Analogamente al recupero dei token, puoi specificare quali token devono essere eliminati impostando un array di chiavi che richiedono l'eliminazione.

Di seguito è riportato un esempio per eliminare determinate chiavi.

Java

BlockstoreClient client = Blockstore.getClient(this);

// Delete data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to delete data stored without key

List requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array
DeleteBytesRequest deleteRequest = new DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build();
client.deleteBytes(deleteRequest)

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build()

client.deleteBytes(retrieveRequest)

Elimina tutti i token

L'esempio che segue elimina tutti i token attualmente salvati in BlockStore:

Java

// Delete all data.
DeleteBytesRequest deleteAllRequest = new DeleteBytesRequest.Builder()
      .setDeleteAll(true)
      .build();
client.deleteBytes(deleteAllRequest)
.addOnSuccessListener(result -> Log.d(TAG, "Any data found and deleted? " + result));

Kotlin

  val deleteAllRequest = DeleteBytesRequest.Builder()
  .setDeleteAll(true)
  .build()
client.deleteBytes(deleteAllRequest)
  .addOnSuccessListener { result: Boolean ->
    Log.d(TAG,
          "Any data found and deleted? $result")
  }

Crittografia end-to-end

Affinché la crittografia end-to-end sia disponibile, il dispositivo deve eseguire Android 9 o versioni successive e l'utente deve aver impostato un blocco schermo (PIN, sequenza o password) per il proprio dispositivo. Puoi verificare se la crittografia sarà disponibile sul dispositivo chiamando isEndToEndEncryptionAvailable().

L'esempio seguente mostra come verificare se la crittografia sarà disponibile durante il backup sul cloud:

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { result ->
          Log.d(TAG, "Will Block Store cloud backup be end-to-end encrypted? $result")
        }

Nota: consigliamo di verificare che la crittografia end-to-end sia disponibile prima di attivare il backup sul cloud.

Abilita backup sul cloud

Per abilitare il backup sul cloud, aggiungi il metodo setShouldBackupToCloud() all'oggetto StoreBytesData. Il negozio di riserva eseguirà periodicamente il backup dei cloud archiviati quando setShouldBackupToCloud() è impostato su true.

L'esempio seguente mostra come attivare il backup sul cloud solo quando il backup sul cloud è criptato end-to-end:

val client = Blockstore.getClient(this)
val storeBytesDataBuilder = StoreBytesData.Builder()
        .setBytes(/* BYTE_ARRAY */)

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { isE2EEAvailable ->
          if (isE2EEAvailable) {
            storeBytesDataBuilder.setShouldBackupToCloud(true)
            Log.d(TAG, "E2EE is available, enable backing up bytes to the cloud.")

            client.storeBytes(storeBytesDataBuilder.build())
                .addOnSuccessListener { result ->
                  Log.d(TAG, "stored: ${result.getBytesStored()}")
                }.addOnFailureListener { e ->
                  Log.e(TAG, “Failed to store bytes”, e)
                }
          } else {
            Log.d(TAG, "E2EE is not available, only store bytes for D2D restore.")
          }
        }

Nota: se storeBytes viene richiamato con shouldBackupToCloud non impostato o impostato su false, i byte di questo dispositivo di cui è stato eseguito il backup in precedenza nel cloud verranno eliminati dal cloud alla successiva sincronizzazione periodica.

Come eseguire il test

Utilizza i seguenti metodi durante lo sviluppo per testare i flussi di ripristino.

Disinstallazione/reinstallazione dello stesso dispositivo

Se l'utente attiva i servizi di backup (puoi controllarlo in Impostazioni > Google > Backup), i dati del Blocco Store vengono conservati per tutta la disinstallazione/reinstallazione dell'app.

Per verificarlo:

1. Integra l'API BlockStore nella tua app di test.
2. Usa l'app di test per richiamare l'API BlockStore per archiviare i dati.
3. Disinstalla l'app di prova e reinstalla l'app sullo stesso dispositivo.
4. Usa l'app di test per richiamare l'API BlockStore per recuperare i dati.
5. Verifica che i byte recuperati corrispondano a quelli memorizzati prima della disinstallazione.

Nota: poiché sono necessari più passaggi per testare il ripristino cross-device, ti consigliamo di verificare prima l'integrazione della tua app con l'API BlockStore utilizzando la richiesta di disinstallazione/reinstallazione.

Dispositivo-dispositivo

Nella maggior parte dei casi, sarà necessario ripristinare i dati di fabbrica del dispositivo di destinazione. Puoi quindi inserire il flusso di ripristino wireless di Android o il ripristino dei cavi di Google (per i dispositivi supportati).

Nota: se il dispositivo di destinazione è un Samsung Galaxy, puoi avviare il flusso di ripristino avviando Smart Switch al di fuori della configurazione.

Ripristino nel cloud

1. Integra l'API Blockstore nella tua app di test. L'app di test deve essere inviata al Play Store.
2. Sul dispositivo di origine, utilizza l'app di test per richiamare l'API Blockstore in cui archiviare i dati, con shouldBackUpToCloud impostato su true.
3. Per i dispositivi O e successivi, puoi attivare manualmente un backup sul cloud dal Blocco Store: vai a Impostazioni > Google > Backup e fai clic sul pulsante "Esegui il backup ora".
   1. Per verificare l'esito positivo del backup sul cloud del Block Store, puoi:
      1. Al termine del backup, cerca le righe di log con il tag "CloudSyncBpTkSvc".
      2. Dovresti vedere righe come: "......, CloudSyncBpTkSvc: sync result: SUCCESS, ..., dimensioni caricate: XXX byte .....".
   2. Dopo il backup sul cloud di Block Store, è previsto un periodo di "raffreddamento" di 5 minuti. Entro 5 minuti, facendo clic sul pulsante "Effettua ora il backup" non verrà attivato un altro backup sul cloud del Block Store.
4. Ripristina i dati di fabbrica del dispositivo di destinazione e segui il flusso di ripristino del cloud. Seleziona per ripristinare l'app di test durante il flusso di ripristino. Per ulteriori informazioni sui flussi di ripristino cloud, consulta Flussi di ripristino cloud supportati.
5. Sul dispositivo di destinazione, utilizza l'app di test per richiamare l'API Blockstore per recuperare i tuoi dati.
6. Verifica che i byte recuperati corrispondano a quelli archiviati nel dispositivo di origine.

Requisiti del dispositivo

Crittografia end-to-end

• La crittografia end-to-end è supportata sui dispositivi con Android 9 (API 29) e versioni successive.
• Il dispositivo deve avere un blocco schermo impostato con un PIN, una sequenza o una password affinché la crittografia end-to-end sia attivata e i dati dell'utente vengano criptati correttamente.

Nota: isEndtoEndEncryptionAvailable() restituisce false se una di queste condizioni non è soddisfatta.

Flusso di ripristino tra dispositivi

Il ripristino da dispositivo a dispositivo richiederà un dispositivo di origine e un dispositivo di destinazione. Questi saranno i due dispositivi che trasferiranno i dati.

Per il backup, i dispositivi di origine devono eseguire Android 6 (API 23) e versioni successive.

Scegli come target dispositivi con Android 9 (API 29) o versioni successive per consentire il ripristino.

Ulteriori informazioni sul flusso di ripristino dei dispositivi sono disponibili qui.

Flusso di backup e ripristino Cloud

Il backup e il ripristino sul cloud richiederanno un dispositivo di origine e un dispositivo di destinazione.

Per il backup, i dispositivi di origine devono eseguire Android 6 (API 23) e versioni successive.

I dispositivi di destinazione sono supportati a seconda dei fornitori. I dispositivi Pixel possono utilizzare questa funzionalità da Android 9 (API 29), tutti gli altri dispositivi devono eseguire Android 12 (API 31) o versioni successive.