Join us for Firebase Summit on November 10, 2021. Tune in to learn how Firebase can help you accelerate app development, release with confidence, and scale with ease. Register

Ativar verificação de aplicativo com reCAPTCHA v3 em aplicativos da web

Esta página mostra como habilitar a verificação de aplicativos em um aplicativo da web, usando o provedor reCAPTCHA v3 integrado. Ao habilitar o App Check, você ajuda a garantir que apenas o seu aplicativo possa acessar os recursos do Firebase do seu projeto. Veja um Overview deste recurso.

Observe que o reCAPTCHA v3 é invisível para os usuários. O provedor reCAPTCHA v3 não exigirá que os usuários resolvam um desafio a qualquer momento. Veja a documentação de v3 reCAPTCHA .

Se você quiser usar o App Verifique com seu próprio provedor personalizado, consulte Implementar um costume App check provedor .

1. Configure seu projeto Firebase

  1. Adicionar Firebase ao seu projeto JavaScript , se você não tiver feito isso.

  2. Cadastre seu site para reCAPTCHA v3 e obter a sua chave local v3 reCAPTCHA e chave secreta.

  3. Registrar seus aplicativos para usar o App Verifique com o provedor de reCAPTCHA nas Configurações do projeto> App check seção do console Firebase. Você terá de fornecer a chave secreta que você tem na etapa anterior.

    Normalmente, você precisa registrar todos os aplicativos do seu projeto, porque depois de habilitar a aplicação para um produto Firebase, apenas os aplicativos registrados poderão acessar os recursos de back-end do produto.

  4. Opcional: Nas configurações de registro de aplicativos, defina um costume time-to-live (TTL) para App check fichas emitidas pelo provedor. Você pode definir o TTL para qualquer valor entre 30 minutos e 7 dias. Ao alterar esse valor, esteja ciente das seguintes desvantagens:

    • Segurança: TTLs mais curtos fornecem segurança mais forte, pois reduzem a janela na qual um token vazado ou interceptado pode ser abusado por um invasor.
    • Desempenho: TTLs mais curtos significam que seu aplicativo executará o atestado com mais frequência. Como o processo de atestado do aplicativo adiciona latência às solicitações de rede sempre que é executado, um TTL curto pode afetar o desempenho do seu aplicativo.
    • Cota: TTLs mais curtos e reafirmações frequentes esgotam sua cota mais rapidamente. Veja Quotas e limites .

    O TTL padrão de 1 dia é razoável para a maioria dos aplicativos.

2. Adicione a biblioteca App Check ao seu aplicativo

Adicionar Firebase ao seu aplicativo web se você não tiver já. Certifique-se de importar a biblioteca App Check.

3. Inicialize a verificação do aplicativo

Adicione o seguinte código de inicialização ao seu aplicativo, antes de acessar qualquer serviço do Firebase. Você vai precisar passar sua chave local reCAPTCHA, que você criou no console reCAPTCHA, para activate() .

Versão 9 da web

const { initializeApp } = require("firebase/app");
const { initializeAppCheck, ReCaptchaV3Provider } = require("firebase/app-check");

const app = initializeApp({
  // Your firebase configuration object
});

// Pass your reCAPTCHA v3 site key (public key) to activate(). Make sure this
// key is the counterpart to the secret key you set in the Firebase console.
const appCheck = initializeAppCheck(app, {
  provider: new ReCaptchaV3Provider('abcdefghijklmnopqrstuvwxy-1234567890abcd'),

  // Optional argument. If true, the SDK automatically refreshes App Check
  // tokens as needed.
  isTokenAutoRefreshEnabled: true
});

Versão 8 da web

firebase.initializeApp({
  // Your firebase configuration object
});

const appCheck = firebase.appCheck();
// Pass your reCAPTCHA v3 site key (public key) to activate(). Make sure this
// key is the counterpart to the secret key you set in the Firebase console.
appCheck.activate(
  'abcdefghijklmnopqrstuvwxy-1234567890abcd',

  // Optional argument. If true, the SDK automatically refreshes App Check
  // tokens as needed.
  true);

Depois que a biblioteca App Check estiver instalada em seu aplicativo, implante-a.

O aplicativo cliente atualizado começará a enviar tokens de verificação de aplicativo junto com todas as solicitações feitas ao Firebase, mas os produtos Firebase não exigirão que os tokens sejam válidos até que você habilite a aplicação na seção Verificação de aplicativo do console do Firebase. Consulte as próximas duas seções para obter detalhes.

4. Monitore as métricas de solicitação

Agora que seu aplicativo atualizado está nas mãos dos usuários, você pode ativar a aplicação da Verificação de aplicativo para os produtos Firebase que você usa. Antes de fazer isso, no entanto, certifique-se de que isso não atrapalhe os usuários legítimos existentes.

Realtime Database e Cloud Storage

Uma ferramenta importante que você pode usar para tomar essa decisão para o Realtime Database e o Cloud Storage é a tela de métricas de solicitação de verificação de aplicativo.

Para visualizar o aplicativo métricas check pedido de produto, abra o Configurações do projeto> App check seção do console Firebase. Por exemplo:

Captura de tela da página de métricas do App Check

As métricas de solicitação para cada produto são divididas em quatro categorias:

  • Pedidos verificados são aqueles que têm uma App válido Verifique token. Depois de habilitar a aplicação da Verificação de aplicativo, apenas as solicitações nesta categoria serão bem-sucedidas.

  • Pedidos de clientes desatualizados são aqueles que estão faltando uma verificação de token App. Essas solicitações podem ser de uma versão mais antiga do Firebase SDK antes de o App Check ser incluído no aplicativo.

  • Solicitações de origem desconhecida são aqueles que estão faltando uma App Verifique forma, e não se parecem com eles vêm do Firebase SDK. Podem ser de solicitações feitas com chaves de API roubadas ou solicitações falsificadas feitas sem o SDK do Firebase.

  • Pedidos inválidos são aqueles que têm uma App inválido Verifique token, que pode ser de um cliente inauthentic tentando personificar a sua aplicação, ou de ambientes emulados.

A distribuição dessas categorias para seu aplicativo deve informar quando você decidir habilitar a aplicação. Aqui estão algumas diretrizes:

  • Se quase todas as solicitações recentes forem de clientes verificados, considere habilitar a aplicação para começar a proteger seus recursos de back-end.

  • Se uma parte significativa das solicitações recentes forem de clientes provavelmente desatualizados, para evitar interromper os usuários, considere esperar que mais usuários atualizem seu aplicativo antes de habilitar a aplicação. Aplicar a verificação de aplicativo em um aplicativo lançado interromperá as versões anteriores do aplicativo que não estão integradas ao SDK do App Check.

  • Se seu aplicativo ainda não foi iniciado, você deve habilitar a aplicação da Verificação de aplicativo imediatamente, uma vez que não há nenhum cliente desatualizado em uso.

Cloud Functions

Para Cloud Functions, você pode obter métricas de verificação de aplicativo examinando os registros de suas funções. Cada invocação de uma função que pode ser chamada emite uma entrada de registro estruturada como o exemplo a seguir:

{
  "severity": "INFO",    // INFO, WARNING, or ERROR
  "logging.googleapis.com/labels": {"firebase-log-type": "callable-request-verification"},
  "jsonPayload": {
    "message": "Callable header verifications passed.",
    "verifications": {
      // ...
      "app": "MISSING",  // VALID, INVALID, or MISSING
    }
  }
}

Você pode analisar essas métricas no Google Cloud Console por criar um registos à base de contra-métrica com o filtro de métrica seguinte:

resource.type="cloud_function"
resource.labels.function_name="YOUR_CLOUD_FUNCTION"
resource.labels.region="us-central1"
labels.firebase-log-type="callable-request-verification"

Rotular a métrica usando o campo jsonPayload.verifications.appCheck .

5. Habilite a aplicação

Para habilitar a aplicação, siga as instruções para cada produto, abaixo. Depois de habilitar a aplicação de um produto, todas as solicitações não verificadas para esse produto serão rejeitadas.

Realtime Database e Cloud Storage

Para ativar a aplicação do Realtime Database e Cloud Storage:

  1. Abra o check Configurações do projeto> App seção do console Firebase.

  2. Expanda a visualização das métricas do produto para o qual deseja ativar a aplicação.

  3. Clique em Aplicar e confirme a sua escolha.

Observe que pode levar até 10 minutos após a ativação da aplicação para que ela entre em vigor.

Cloud Functions

Veja Ativar App Verifique a aplicação das Funções de nuvem .

Próximos passos

Se, depois de registrar seu aplicativo para App Check, você deseja executar seu aplicativo em um ambiente que App Check normalmente não classificaria como válido, como localmente durante o desenvolvimento ou de um ambiente de integração contínua (CI), você pode criar uma compilação de depuração de seu aplicativo que usa o provedor de depuração App Check em vez de um provedor de atestado real.

Veja Uso App Verifique com o provedor de depuração em aplicações web .