Selecione a plataforma: Android iOS JavaScript

Usar o App Check para proteger sua chave de API

O Firebase App Check protege as chamadas do seu app para a Plataforma Google Maps bloqueando o tráfego de fontes que não sejam apps legítimos. Para isso, ele verifica se há um token de um provedor de atestado, como a Play Integrity. A integração dos seus apps com o App Check ajuda a proteger contra solicitações maliciosas, para que você não receba cobranças por chamadas de API não autorizadas.

O App Check é ideal para mim?

O App Check é recomendado na maioria dos casos, mas não é necessário ou não é compatível nos seguintes casos:

  • Você está usando o SDK do Places original. O App Check só é compatível com o SDK do Places (novo).
  • Apps particulares ou experimentais. Se o app não estiver acessível publicamente, o App Check não será necessário.
  • Se o app for usado apenas entre servidores, o App Check não será necessário. No entanto, se o servidor que se comunica com a GMP for usado por clientes públicos (como apps para dispositivos móveis), considere usar o App Check para proteger esse servidor em vez da GMP.
  • Os provedores de atestado recomendados do App Check não funcionam em dispositivos considerados comprometidos ou não confiáveis pelo provedor de atestado. Se você precisar oferecer suporte a esses dispositivos, implante um serviço de atestado personalizado. Para mais informações, consulte as instruções.

Visão geral das etapas de implementação

Em geral, estas são as etapas para integrar seu app ao App Check:

  1. Adicione o Firebase ao aplicativo.
  2. Adicione e inicialize a biblioteca do App Check.
  3. Adicione o provedor de token.
  4. Ative a depuração.
  5. Monitore as solicitações do app e decida sobre a aplicação.

Depois de integrar o App Check, você poderá ver as métricas de tráfego de back-end no console do Firebase. Essas métricas detalham as solicitações de acordo com a presença de um token válido do App Check. Consulte a documentação do Firebase App Check para mais informações.

Quando você tiver certeza de que a maioria das solicitações é de fontes legítimas e que os usuários atualizaram para a versão mais recente do app que inclui a implementação do App Check, ative a aplicação obrigatória. Quando a aplicação estiver ativada, o App Check vai rejeitar todo o tráfego sem um token válido.

Considerações ao planejar uma integração do App Check

Confira alguns aspectos a serem considerados ao planejar sua integração:

  • O provedor de atestado que recomendamos, a Play Integrity, tem um limite diário de chamadas para o nível de uso da API padrão. Para mais informações sobre os limites de chamadas, consulte a página Configuração na documentação para desenvolvedores da API Google Play Integrity.

    Também é possível usar um provedor de atestado personalizado, embora esse seja um caso de uso avançado. Para mais informações, consulte Implementar um provedor personalizado do App Check.

  • Os usuários do seu app vão notar alguma latência na inicialização. No entanto, depois disso, qualquer reatestação periódica vai ocorrer em segundo plano, e os usuários não vão mais notar latência. A latência exata na inicialização depende do provedor de atestado escolhido.

    O período de validade do token do App Check (o time to live, ou TTL) determina a frequência das novas atestações. Essa duração pode ser configurada no console do Firebase. A reatestação ocorre quando aproximadamente metade do TTL tiver decorrido. Para mais informações, consulte os documentos do Firebase do seu provedor de atestado.

Integrar seu app ao App Check

Pré-requisitos e requisitos

  • Um app com o SDK do Places versão 4.1 ou mais recente integrado.
  • A impressão digital SHA-256 do seu app.
  • O nome do pacote do seu app.
  • Você precisa ser o proprietário do app no console do Cloud.
  • Você vai precisar do ID do projeto do app no console do Cloud.

Etapa 1: adicionar o Firebase ao app

Siga as instruções na documentação para desenvolvedores do Firebase para adicionar o Firebase ao seu app.

Etapa 2: adicionar a biblioteca do App Check e inicializar o App Check

Para saber como usar a Play Integrity, o provedor de atestado padrão, consulte Começar a usar o App Check com a Play Integrity no Android.

  1. Se ainda não fez isso, integre o SDK do Places ao seu app.

  2. Em seguida, inicialize o App Check e o cliente do Places.

    // Initialize App Check
FirebaseApp.initializeApp(/* context= */ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());
  
// Initialize Places SDK
Places.initializeWithNewPlacesApiEnabled(context, API_KEY);
PlacesClient client = Places.createClient(context);.

Etapa 3: adicionar o provedor de token

Depois de inicializar a API Places, chame setPlacesAppCheckTokenProvider() para definir o PlacesAppCheckTokenProvider. 

Places.initializeWithNewPlacesApiEnabled(context, API_KEY);
Places.setPlacesAppCheckTokenProvider(new TokenProvider());
PlacesClient client = Places.createClient(context);.

Confira um exemplo de implementação da interface do buscador de tokens: 

  /** Sample client implementation of App Check token fetcher interface. */
  static class TokenProvider implements PlacesAppCheckTokenProvider {
    @Override
    public ListenableFuture<String> fetchAppCheckToken() {
      SettableFuture<String> future = SettableFuture.create();
      FirebaseAppCheck.getInstance()
          .getAppCheckToken(false)
          .addOnSuccessListener(
              appCheckToken -> {
                future.set(appCheckToken.getToken());
              })
          .addOnFailureListener(
              ex -> {
                future.setException(ex);
              });

      return future;
    }
  }

Etapa 4: ativar a depuração (opcional)

Se você quiser desenvolver e testar seu app localmente ou executá-lo em um ambiente de integração contínua (CI), crie um build de depuração do app que use um secret de depuração para receber tokens válidos do App Check. Isso permite que você evite o uso de provedores de atestado reais no build de depuração.

Para executar o app em um emulador ou dispositivo de teste:

  • Adicione a biblioteca do App Check ao arquivo build.gradle.
  • Configure o App Check para usar a fábrica do provedor de depuração no seu build de depuração.
  • Inicie o app, que vai criar um token de depuração local. Adicione esse token ao console do Firebase.
  • Para mais informações e instruções, consulte a documentação do App Check.

Para executar o app em um ambiente de CI:

  • Crie um token de depuração no console do Firebase e adicione-o ao armazenamento de chaves seguras do seu sistema de CI.
  • Adicione a biblioteca do App Check ao arquivo build.gradle.
  • Configure a variante de build de CI para usar o token de depuração.
  • Nas classes de teste, use DebugAppCheckTestHelper para agrupar o código que precisa de um token do App Check.
  • Para mais informações e instruções, consulte a documentação do App Check.

Etapa 5: monitorar as solicitações do app e decidir sobre a aplicação

Antes de começar a aplicação, verifique se você não vai interromper os usuários legítimos do app. Para isso, acesse a tela de métricas do App Check para ver qual porcentagem do tráfego do app é verificada, desatualizada ou ilegítima. Quando a maior parte do tráfego estiver verificada, você poderá ativar a aplicação.

Consulte a documentação do Firebase App Check para mais informações e instruções.