Loja de blocos

Observação:para ter uma experiência do usuário atualizada e outras melhorias, use chaves de acesso com o Gerenciador de credenciais .

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, busca 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 autenticar novamente os 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 ver 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 criptografado 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.
• Elimine o atrito dos fluxos de login.
• Evite que os usuários precisem gerenciar senhas complexas.
• O Google verifica a identidade do usuário.

Observação: o uso da Block Store não limita o usuário ao tipo de credenciais que pode ser utilizado. Os usuários podem fazer login com o nome de usuário e senha, a Conta do Google ou qualquer outro provedor de identidade federado, e o Block Store ainda funciona.

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 seu módulo, que geralmente é app/build.gradle:

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

Como funciona

O armazenamento de blocos permite que os desenvolvedores salvem e restaurem matrizes de até 16 bytes. Isso permite salvar informações importantes relacionadas à sessão atual do usuário e oferece a flexibilidade de salvar essas informações como você quiser. Esses dados podem ser criptografados de ponta a ponta, e a infraestrutura que oferece suporte ao armazenamento em blocos é construída sobre a infraestrutura de backup e restauração.

Este guia aborda o caso de uso de salvar o token de um usuário no Block Store. As etapas a seguir descrevem como um app que utiliza 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 armazenado 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.

Como salvar o token

Quando um usuário faz login no app, é possível salvar o token de autenticação gerado para ele na loja bloqueada. É possível armazenar esse token usando um valor de par de chaves exclusivo com 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, ele é criptografado e armazenado localmente no dispositivo.

O exemplo abaixo 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)
    }

Bytes armazenados anteriormente sem uma chave?

Se você já usou a API StoreBytes() para salvar seus dados, é recomendável começar a salvar seus tokens com uma chave. Os dados salvos anteriormente usando StoreBytes agora são salvos com a chave BlockstoreClient.DEFAULT_BYTES_DATA_KEY.

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 os dados são armazenados no dispositivo e quem pode acessar os dados?

No dispositivo, os dados da BlockStore são armazenados no diretório de dados particulares local do Google Play Services. Nenhum outro app pode acessar diretamente o arquivo de dados. Eles só podem acessar os dados do BlockStore pela API retrieveBytes(), e um app só pode recuperar os dados armazenados por conta própria. O Google Play Services verifica o nome do pacote e a assinatura.

Como recuperar o token

Depois, quando um usuário passar pelo fluxo de restauração em um novo dispositivo, o Google Play Services vai verificar o usuário e, em seguida, recuperar os dados da Block Store. O usuário já concordou em restaurar os dados do app como parte do fluxo de restauração. Portanto, nenhum outro consentimento é necessário. Quando o usuário abre seu app, é possível 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)
  }

Recuperando todos os tokens.

Abaixo está 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)
  }

Descontinuação do retrieveBytes().

O retrieveBytes() foi descontinuado. Para recuperar bytes, a chave BlockstoreClient.DEFAULT_BYTES_DATA_KEY pode ser usada na instância RetrieveBytesRequest para acessar seus dados salvos

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)

Como excluir tokens

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

• O usuário passa pelo fluxo de usuário para sair.
• O token foi revogado ou é inválido.

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

Confira abaixo um exemplo de como excluir determinadas 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 ter o Android 9 ou mais recente e o usuário precisa ter definido um bloqueio de tela (PIN, padrão ou senha) para o dispositivo. Para verificar se a criptografia vai estar disponível no dispositivo, chame 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")
        }

Observação :recomendamos verificar se a criptografia de ponta a ponta está disponível antes de ativar o backup na nuvem.

Ativar backup na nuvem

Para ativar o backup na nuvem, adicione o método setShouldBackupToCloud() ao objeto StoreBytesData. O armazenamento de blocos fará backups periódicos 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 for 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.")
          }
        }

Observação: se storeBytes for chamado com shouldBackupToCloud desconfigurado ou definido como false, os bytes deste dispositivo salvos em backup na nuvem serão excluídos na próxima sincronização periódica.

Como testar

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

Desinstalar/reinstalar no mesmo dispositivo

Se o usuário ativar os serviços de backup (isso pode ser conferido em Configurações > Google > Backup), os dados do armazenamento bloqueado 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 desinstalação.

Observação: como é necessário testar a restauração em dispositivos diferentes, é recomendável verificar primeiro a integração do app com a API BlockStore usando o caso de desinstalação/reinstalação.

Entre dispositivos

Na maioria dos casos, isso exige a redefinição do dispositivo de destino para a configuração original. Em seguida, insira o fluxo de restauração sem fio do Android ou a restauração do cabo do Google (para dispositivos com suporte).

Observação: se o dispositivo de destino for um Samsung Galaxy, será possível entrar no fluxo de restauração iniciando o Smart Switch fora da configuração.

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 seus dados, com " shouldBackUpToCloud" definido como "true".
3. Para dispositivos O e acima, é possível acionar manualmente um backup na nuvem do Block Store: acesse Configurações > Google > Backup, 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. Depois que o backup for concluído, pesquise as 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 até cinco minutos, clicar no botão "Fazer backup agora" não acionará outro backup na nuvem da Block Store.
4. redefinir o dispositivo de destino para a configuração original e passar por um fluxo de restauração na nuvem; Selecione para restaurar o app de teste durante o fluxo de restauração. Para mais informações sobre os 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 extrair os 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 está disponível em dispositivos com o Android 9 (API 29) 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 criptografe corretamente os dados do usuário.

Observação: isEndtoEndEncryptionAvailable() retornará "false" se alguma dessas condições não for atendida.

Fluxo de restauração de dispositivo para dispositivo

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

Para fazer backup, os dispositivos de origem precisam ter o Android 6 (API 23) ou mais recente.

Destinar a dispositivos com o Android 9 (API 29) e versões mais recentes que possam ser restaurados.

Confira mais informações sobre o fluxo de restauração de dispositivo para dispositivo neste link.

Fluxo de backup e restauração na nuvem

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

Para fazer backup, os dispositivos de origem precisam ter o Android 6 (API 23) ou mais recente.

Os dispositivos de destino são compatíveis com base nos fornecedores. Os dispositivos Pixel podem usar esse recurso do Android 9 (nível 29 da API) e todos os outros precisam ter o Android 12 (nível 31 da API) ou uma versão mais recente.