Loja de blocos

Muitos usuários ainda gerenciam as próprias credenciais ao configurar um novo dispositivo Android. Esse processo manual pode se tornar desafiador e muitas vezes resulta em uma experiência ruim para o usuário. A API Block Store, uma biblioteca com tecnologia do Google Play Services, tenta resolver isso oferecendo uma maneira de os apps salvarem credenciais de usuário sem a complexidade ou o risco de segurança associado ao salvamento de senhas de usuário.

A API Block Store permite que o app armazene dados que podem ser recuperados posteriormente para reautenticar usuários em um novo dispositivo. Isso ajuda a fornecer uma experiência mais simples para o usuário, já que ele não precisa conferir uma tela de login ao iniciar o app pela primeira vez no novo dispositivo.

Os benefícios de usar a Block Store incluem:

  • Solução de armazenamento de credenciais criptografadas para desenvolvedores. As credenciais são criptografadas de ponta a ponta quando possível.
  • Salvar tokens em vez de nomes de usuário e senhas.
  • Eliminar o atrito dos fluxos de login.
  • Evite que os usuários precisem gerenciar senhas complexas.
  • O Google verifica a identidade do usuário.

Antes de começar

Para preparar o app, siga as etapas nas seções a seguir.

Configurar o app

No arquivo build.gradle no nível do projeto, inclua o repositório Maven do Google nas seções buildscript e allprojects:

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

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

Adicione a dependência do Google Play Services para a API Block Store ao arquivo de build do Gradle do módulo, que geralmente é app/build.gradle:

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

Como funciona

O Block Store permite que os desenvolvedores salvem e restaurem matrizes de até 16 bytes. Isso permite que você salve informações importantes sobre a sessão do usuário atual e oferece a flexibilidade de salvar essas informações como você quiser. Esses dados podem ser criptografados de ponta a ponta, e a infraestrutura de suporte ao Block Store é criada com base na infraestrutura de backup e restauração.

Este guia abordará o caso de uso de salvar o token de um usuário no Block Store. As etapas a seguir descrevem como um app usando a Block Store funcionaria:

  1. Durante o fluxo de autenticação do app ou a qualquer momento depois disso, é possível armazenar o token de autenticação do usuário no Block Store para recuperação posterior.
  2. O token será armazenado localmente e também poderá ser salvo em backup na nuvem, com criptografia de ponta a ponta, quando possível.
  3. Os dados são transferidos quando o usuário inicia um fluxo de restauração em um novo dispositivo.
  4. Se o usuário restaurar o app durante o fluxo de restauração, o app poderá recuperar o token salvo da Block Store no novo dispositivo.

Salvar o token

Quando um usuário faz login no seu app, você pode salvar no Block Store o token de autenticação gerado para esse usuário. Você pode armazenar esse token usando um valor de par de chaves exclusivo que tenha no máximo 4 KB por entrada. Para armazenar o token, chame setBytes() e setKey() em uma instância de StoreBytesData.Builder para armazenar as credenciais do usuário no dispositivo de origem. Depois de salvar o token com o Block Store, o token é criptografado e armazenado localmente no dispositivo.

O exemplo a seguir mostra como salvar o token de autenticação no dispositivo local:

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

Usar token padrão

Os dados salvos usando StoreBytes sem uma chave usam a chave padrão BlockstoreClient.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)
    }

Como recuperar o token

Mais tarde, quando um usuário passa pelo fluxo de restauração em um novo dispositivo, o Google Play Services verifica o usuário primeiro e depois recupera os dados da Block Store. O usuário já concordou em restaurar os dados do app como parte do fluxo de restauração, então nenhum outro consentimento é necessário. Quando o usuário abrir o app, você poderá solicitar seu token da Block Store chamando retrieveBytes(). O token recuperado pode ser usado para manter o usuário conectado no novo dispositivo.

O exemplo a seguir mostra como recuperar vários tokens com base em chaves específicas.

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

Como recuperar todos os tokens

Confira abaixo um exemplo de como recuperar todos os tokens salvos no 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)
  }

Confira abaixo um exemplo de como recuperar a chave padrão.

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)

Excluir tokens

A exclusão de tokens da BlockStore pode ser necessária pelos seguintes motivos:

  • O usuário passa pelo fluxo de saída do usuário.
  • O token foi revogado ou é inválido.

Assim como na recuperação de tokens, é possível especificar quais deles precisam ser excluídos definindo uma matriz de chaves que exigem exclusão.

Confira abaixo um exemplo de exclusão de algumas chaves.

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)

Excluir todos os tokens

O exemplo abaixo exclui todos os tokens salvos atualmente no 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")
  }

Criptografia de ponta a ponta

Para que a criptografia de ponta a ponta seja disponibilizada, o dispositivo precisa executar o Android 9 ou mais recente, e o usuário precisa definir um bloqueio de tela (PIN, padrão ou senha) para o dispositivo. É possível verificar se a criptografia estará disponível no dispositivo chamando isEndToEndEncryptionAvailable().

O exemplo a seguir mostra como verificar se a criptografia estará disponível durante o backup na nuvem:

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

Ative o backup na nuvem

Para ativar o backup na nuvem, adicione o método setShouldBackupToCloud() ao objeto StoreBytesData. O Block Store fará o backup periódico dos bytes armazenados na nuvem quando setShouldBackupToCloud() for definido como verdadeiro.

O exemplo a seguir mostra como ativar o backup na nuvem somente quando ele é criptografado de ponta a ponta:

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.")
          }
        }

Como testar

Use os métodos a seguir durante o desenvolvimento para testar os fluxos de restauração.

Desinstale/reinstalação no mesmo dispositivo

Se o usuário ativar os serviços de backup (isso pode ser verificado em Configurações > Google > Backup), os dados da Block Store serão mantidos na desinstalação/reinstalação do app.

Siga estas etapas para testar:

  1. Integre a API BlockStore ao app de teste.
  2. Use o app de teste para invocar a API BlockStore e armazenar seus dados.
  3. Desinstale o app de teste e reinstale-o no mesmo dispositivo.
  4. Use o app de teste para invocar a API BlockStore e recuperar seus dados.
  5. Verifique se os bytes recuperados são os mesmos armazenados antes da instalação.

Dispositivo para dispositivo

Na maioria dos casos, será necessário redefinir o dispositivo de destino para a configuração original. Depois, entre no fluxo de restauração sem fio do Android ou na restauração de cabos do Google, para dispositivos com suporte.

Restauração na nuvem

  1. Integre a API Blockstore ao app de teste. O app de teste precisa ser enviado à Play Store.
  2. No dispositivo de origem, use o app de teste para invocar a API Blockstore e armazenar os dados, com shouldBackUpToCloud definido como verdadeiro.
  3. Para dispositivos O e mais recentes, é possível acionar manualmente um backup na nuvem da Block Store: acesse Configurações > Google > Backup e clique no botão "Fazer backup agora".
    1. Para verificar se o backup na nuvem do Block Store foi concluído, faça o seguinte:
      1. Quando o backup for concluído, procure linhas de registro com a tag "CloudSyncBpTkSvc".
      2. Você verá linhas como estas: “......, CloudSyncBpTkSvc: sync result: SUCCESS, ..., upload size: XXX bytes ...”
    2. Depois de um backup na nuvem da Block Store, há um período de "resfriamento" de cinco minutos. Em cinco minutos, clicar no botão "Fazer backup agora" não aciona outro backup na nuvem da Block Store.
  4. Redefina o dispositivo de destino para a configuração original e passe pelo fluxo de restauração da nuvem. Selecione para restaurar o app de teste durante o fluxo de restauração. Para mais informações sobre fluxos de restauração na nuvem, consulte Fluxos de restauração de nuvem compatíveis.
  5. No dispositivo de destino, use o app de teste para invocar a API Blockstore e recuperar seus dados.
  6. Verifique se os bytes recuperados são os mesmos armazenados no dispositivo de origem.

Requisitos do dispositivo

Criptografia de ponta a ponta

  • A criptografia de ponta a ponta tem suporte em dispositivos com o Android 9 (nível 29 da API) e versões mais recentes.
  • O dispositivo precisa ter um bloqueio de tela definido com um PIN, um padrão ou uma senha para que a criptografia de ponta a ponta seja ativada e os dados do usuário sejam criptografados corretamente.

Fluxo de restauração de dispositivo para dispositivo

A restauração de dispositivo para dispositivo exige que você tenha um dispositivo de origem e um de destino. Esses serão os dois dispositivos que estão transferindo dados.

Os dispositivos de origem precisam executar o Android 6 (nível 23 da API) ou mais recente para fazer backup.

Segmente dispositivos com o Android 9 (nível 29 da API) e versões mais recentes para permitir a restauração.

Saiba mais sobre o fluxo de restauração de dispositivos.

Fluxo de backup e restauração na nuvem

O backup e a restauração na nuvem exigem um dispositivo de origem e um de destino.

Os dispositivos de origem precisam executar o Android 6 (nível 23 da API) ou mais recente para fazer backup.

Os dispositivos de segmentação são aceitos de acordo com os fornecedores. Os dispositivos Pixel podem usar esse recurso do Android 9 (nível 29 da API) e todos os outros dispositivos precisam ter o Android 12 (nível 31 da API) ou mais recente.