Restaurar as credenciais do app ao configurar um novo dispositivo

Com o recurso Restaurar credenciais do Gerenciador de credenciais, os usuários podem restaurar as contas de apps ao configurar um novo dispositivo. Essa API está em prévia para desenvolvedores e disponível em todos os dispositivos com Android 9 ou mais recente e a versão 242200000 ou mais recente do Google Play Services (GMS) Core. Os benefícios do recurso "Restaurar credenciais" incluem:

• Experiência otimizada do usuário: os usuários podem restaurar a conta do app sem precisar fazer login manualmente em cada um deles.
• Aumento do engajamento dos usuários: é mais provável que os usuários continuem usando seu app se puderem restaurar a conta ao configurar um novo dispositivo.
• Redução do esforço de desenvolvimento: o recurso "Restaurar credenciais" é integrado ao Gerenciador de credenciais. Assim, os desenvolvedores que já oferecem suporte a chaves de acesso podem adicionar recursos de restauração de credenciais.

Como funciona

É possível usar "Restaurar credenciais" para criar, receber e limpar as credenciais relevantes.

1. Crie a credencial de restauração: quando o usuário fizer login no seu app, crie uma credencial de restauração associada à conta dele. Essa credencial é armazenada localmente e sincronizada com a nuvem se o usuário tiver ativado o Google Backup e a criptografia de ponta a ponta estiver disponível. Os apps podem desativar a sincronização com a nuvem.
2. Receber a credencial de restauração: quando o usuário configura um novo dispositivo, seu app pode solicitar a credencial de restauração do Gerenciador de credenciais. Isso permite fazer login do usuário automaticamente sem exigir nenhuma entrada adicional.
3. Limpe a credencial de restauração: quando o usuário sair do app, você precisa excluir a credencial de restauração associada.

O recurso "Restaurar credenciais" pode ser integrado sem problemas a sistemas de back-end que já implementaram chaves de acesso. Essa compatibilidade decorre do fato de que as chaves de acesso e as chaves de recuperação (tipo de credencial usado pelo recurso "Restaurar credenciais") seguem as mesmas especificações técnicas. Esse alinhamento garante que o processo de restauração de credenciais possa recuperar e restabelecer com eficácia as credenciais do usuário armazenadas em sistemas compatíveis com chaves de acesso, oferecendo uma experiência consistente e fácil de usar em diferentes plataformas e métodos de autenticação.

Implementação

A API Restore Credentials está disponível na biblioteca do Jetpack Credential Manager. Para começar, siga estas etapas:

1. Adicione a dependência do Credential Manager ao seu projeto.

   // build.gradle.kts
   implementation("androidx.credentials:credentials:1.5.0-alpha03")
   

2. Crie um objeto CreateRestoreCredentialRequest.

3. Chame o método createCredential() no objeto CredentialManager.

   val credentialManager = CredentialManager.create(context)
   
   // On a successful authentication create a Restore Key
   // Pass in the context and CreateRestoreCredentialRequest object
   val response = credentialManager.createCredential(context, createRestoreRequest)
   RestoreCredentialsFunctions.kt
   

   Essa credencial de recuperação gerada é um tipo de credencial do WebAuthn e é conhecida como chave de recuperação.

4. Quando o usuário configurar um novo dispositivo, chame o método getCredential() no objeto CredentialManager.

   // Fetch the Authentication JSON from server
   val authenticationJson = fetchAuthenticationJson()
   
   // Create the GetRestoreCredentialRequest object
   val options = GetRestoreCredentialOption(authenticationJson)
   val getRequest = GetCredentialRequest(listOf(options))
   
   // The restore key can be fetched in two scenarios to
   // 1. On the first launch of app on the device, fetch the Restore Key
   // 2. In the onRestore callback (if the app implements the Backup Agent)
   val response = credentialManager.getCredential(context, getRequest)
   RestoreCredentialsFunctions.kt
   

5. Quando o usuário sair do app, chame o método clearCredentialState() no objeto CredentialManager.

   // Create a ClearCredentialStateRequest object
   val clearRequest = ClearCredentialStateRequest(TYPE_CLEAR_RESTORE_CREDENTIAL)
   
   // On user log-out, clear the restore key
   val response = credentialManager.clearCredentialState(clearRequest)
   RestoreCredentialsFunctions.kt
   

Se você estiver usando um agente de backup, execute a parte getCredential no callback onRestore. Isso garante que as credenciais do app sejam restauradas imediatamente após a restauração dos dados do app.