Migrar do reCAPTCHA clássico

Neste documento, mostramos como migrar uma chave de site ativa do reCAPTCHA Classic para os níveis do reCAPTCHA em um projetoGoogle Cloud . O processo de migração leva de cinco a dez minutos para ser concluído e não requer alterações no código.

Se você gerencia suas chaves no Admin Console do reCAPTCHA, está usando o reCAPTCHA Classic, que tem recursos limitados e limites rígidos para uso mensal. Os recursos mais recentes do reCAPTCHA só estão disponíveis para chaves de site gerenciadas em um projeto Google Cloud . Para mais informações sobre os recursos disponíveis, consulte Comparar níveis do reCAPTCHA.

As seguintes mudanças ocorrem após a conclusão do processo de migração:

• Suas chaves de site estão disponíveis em um projeto Google Cloud sem nenhuma mudança.
• Sua integração do reCAPTCHA vai continuar funcionando sem exigir mudanças no código. Você pode manter a mesma instrumentação de página da Web e chamadas de back-end. No entanto, para acessar recursos como a proteção de conta ou a detecção de vazamento de senha, é necessário modificar a instrumentação da página da Web e as chamadas de back-end. Para mais informações, consulte Como usar os recursos do reCAPTCHA após a migração.
• Você vai receber uma cobrança quando exceder o limite mensal gratuito do reCAPTCHA, que é de 10.000 avaliações por mês. Para mais informações, consulte Informações de faturamento.

Observação: as chaves do reCAPTCHA v2 para Android não podem ser migradas.

Antes de começar

1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Go to project selector

2. Make sure that billing is enabled for your Google Cloud project.

   O reCAPTCHA exige que o faturamento seja vinculado e ativado no projeto para a migração. É possível ativar o faturamento usando um cartão de crédito ou um ID de faturamento de projeto Google Cloud atual. Se precisar de ajuda com o faturamento, entre em contato com o suporte do Cloud Billing.

3. Se você quiser executar a CLI gcloud fora do console do Google Cloud, instale e inicialize a CLI gcloud. Para instruções, consulte

   Install the Google Cloud CLI, then initialize it by running the following command:

   gcloud init

Ativar a API reCAPTCHA Enterprise

Todos os níveis do reCAPTCHA (Essentials, Standard e Enterprise) são executados na API reCAPTCHA Enterprise.

Console

1. No console do Google Cloud, acesse a página API reCAPTCHA Enterprise.

   Acessar a API reCAPTCHA Enterprise

2. Verifique se o nome do projeto aparece no seletor de projetos, na parte superior da página.

   Se você não encontrar o nome do projeto, clique no seletor de projetos e selecione o projeto.

3. Clique em Ativar.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. Para definir o projeto Google Cloud na sessão gcloud, execute o comando gcloud config set project. Substitua PROJECT_ID pelo ID do projeto Google Cloud .

          gcloud config set project PROJECT_ID
          

3. Para ativar a API reCAPTCHA Enterprise, execute o comando gcloud services enable:

            gcloud services enable recaptchaenterprise.googleapis.com
          

4. Para verificar se a API reCAPTCHA Enterprise está ativada, execute o comando gcloud services list:

            gcloud services list --enabled
          

   Verifique se a API reCAPTCHA Enterprise está listada na lista de APIs ativadas.

Migrar para o reCAPTCHA

Para migrar o reCAPTCHA clássico para o reCAPTCHA, escolha uma chave de site ativa no Admin Console do reCAPTCHA e migre a chave. É possível migrar uma ou mais chaves de site ativas. No entanto, só é possível migrar uma chave de site por vez.

Para executar o processo de migração, você precisa ter uma conta de usuário do reCAPTCHA que atenda aos seguintes requisitos:

• No Admin Console do reCAPTCHA, a conta de usuário é listada como proprietária da chave de site que você quer migrar.
• A conta de usuário tem um dos seguintes papéis do IAM para o projeto Google Cloud em que a API reCAPTCHA Enterprise está ativada:
  • Proprietário do projeto (roles/owner)
  • Editor do projeto (roles/editor)
  • Administrador do reCAPTCHA (roles/recaptchaenterprise.admin)
  Se a conta de usuário não tiver um desses papéis, peça ao administrador para conceder o papel ou siga as instruções em Como conceder, alterar e revogar acesso.

1. Migre a chave de site usando o console do Google Cloud, o Cloud Shell, a CLI do Google Cloud ou a API reCAPTCHA Enterprise.

   A migração da chave do site não afeta a chave nem os endpoints da API. Ela adiciona a chave à licença empresarial.

   Console do Google Cloud

   1. No console do Google Cloud, acesse a página reCAPTCHA.

      Acessar o reCAPTCHA

   2. Verifique se o nome do projeto aparece no seletor de recursos na parte de cima da página. Se você não encontrar o nome do projeto, clique no seletor de recursos e selecione o projeto.

   3. Na seção Chaves clássicas, identifique a chave que você quer migrar e clique em Fazer upgrade da chave.

      

   4. Para concluir a migração da chave selecionada, clique em Confirmar.

   Cloud Shell

   1. No console do Google Cloud, acesse o Cloud Shell.

      Acesse o Cloud Shell

   2. Se for solicitado, clique em Autorizar.

   3. Escolha e copie uma chave de site ativa que você usou para integrar o reCAPTCHA às suas páginas da Web:

      1. Acesse o Admin Console do reCAPTCHA e clique em .

      2. Escolha uma chave de site. As seguintes chaves de site reCAPTCHA são compatíveis com a migração: caixa de seleção reCAPTCHA v2, reCAPTCHA v2 invisível e reCAPTCHA v3.

      3. Para copiar a chave do site, clique em Copiar chave do site.

   4. Migre a chave do site.

      Execute o comando gcloud recaptcha keys migrate conforme mostrado no exemplo a seguir:

       gcloud recaptcha keys migrate SITE_KEY --project PROJECT-ID
      

      Forneça os valores a seguir:

      • SITE_KEY: a chave de site ativa que você copiou no Admin Console do reCAPTCHA.
      • PROJECT-ID: o ID do projeto Google Cloud em que a API reCAPTCHA Enterprise está ativada.

   CLI da gcloud

   1. Para configurar a autenticação, execute o seguinte comando gcloud:

      gcloud auth login
      

      Faça login com a conta de usuário do reCAPTCHA que é proprietário da chave de site escolhida e que tenha um dos seguintes papéis: Proprietário do projeto, Editor do projeto ou Administrador do reCAPTCHA Enterprise.

   2. Escolha e copie uma chave de site ativa que você usou para integrar o reCAPTCHA às suas páginas da Web:

      1. Acesse o Admin Console do reCAPTCHA e clique em .

      2. Escolha uma chave de site. As seguintes chaves de site reCAPTCHA são compatíveis com a migração: caixa de seleção reCAPTCHA v2, reCAPTCHA v2 invisível e reCAPTCHA v3.

      3. Para copiar a chave do site, clique em Copiar chave do site.

   3. Migre a chave do site.

      Execute o comando gcloud recaptcha keys migrate conforme mostrado no exemplo a seguir:

       gcloud recaptcha keys migrate SITE_KEY --project PROJECT-ID
      

      Forneça os valores a seguir:

      • SITE_KEY: a chave de site ativa que você copiou no Admin Console do reCAPTCHA.
      • PROJECT-ID: o ID do projeto Google Cloud em que a API reCAPTCHA Enterprise está ativada.

   API REST

   1. Escolha e copie uma chave de site ativa que você usou para integrar o reCAPTCHA às suas páginas da Web:

      1. Acesse o Admin Console do reCAPTCHA e clique em .

      2. Escolha uma chave de site. As seguintes chaves de site reCAPTCHA são compatíveis com a migração: caixa de seleção reCAPTCHA v2, reCAPTCHA v2 invisível e reCAPTCHA v3.

      3. Para copiar a chave do site, clique em Copiar chave do site.

   2. Migre a chave do site.

      Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

      • PROJECT_ID: o ID do projeto Google Cloud em que a API reCAPTCHA está ativada.
      • SITE_KEY: a chave de site ativa que você copiou no Admin Console do reCAPTCHA.

      Método HTTP e URL:

      POST https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys/SITE_KEY:migrate

      Para enviar a solicitação, escolha uma destas opções:

      curl

      Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

      execute o seguinte comando:

      curl -X POST \
           -H "Authorization: Bearer $(gcloud auth print-access-token)" \
           -H "Content-Type: application/json; charset=utf-8" \
           -d "" \
           "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys/SITE_KEY:migrate"

      PowerShell

      Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

      execute o seguinte comando:

      $cred = gcloud auth print-access-token
      $headers = @{ "Authorization" = "Bearer $cred" }
      
      Invoke-WebRequest `
          -Method POST `
          -Headers $headers `
          -Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys/SITE_KEY:migrate" | Select-Object -Expand Content

      Você receberá uma resposta JSON semelhante a esta:

      {
        "name": "projects/PROJECT-ID/keys/6Ldqgs0UAAAAAIn4k7YxEB-LwEh5S9-Gv6IIWB8m",
        "displayName": "My site key",
        "webSettings": {
          "allowAllDomains": false,
          "allowedDomains": [
            recaptcha.net
          ],
          "allowAmpTraffic": false,
          "integrationType": "SCORE",
          "challengeSecurityPreference": "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED"
        }
      }
      

2. Para verificar se a chave de site foi migrada, faça o seguinte:

   Console do Google Cloud

   Acesse a página do reCAPTCHA e encontre a chave de site migrada na seção chaves do reCAPTCHA.

   Acessar o reCAPTCHA

   Cloud Shell

   Execute o comando gcloud recaptcha keys list e encontre a chave de site migrada na lista.

   CLI da gcloud

   Execute o comando gcloud recaptcha keys list e encontre a chave de site migrada na lista.

Depois de migrar para o reCAPTCHA, é possível continuar usando o método siteverify para avaliar o token de resposta reCAPTCHA de um usuário.

Observação: não exclua chaves de site do Admin Console do reCAPTCHA ou da página do reCAPTCHA do Console do Google Cloud. Quando você exclui uma chave de site, ela é excluída dos dois consoles e a proteção oferecida pelo reCAPTCHA é removida.

É possível revogar o papel do IAM de Administrador do reCAPTCHA Enterprise (roles/recaptchaenterprise.admin) na conta de usuário do reCAPTCHA. Peça para o administrador revogar o acesso ou siga as instruções sobre Como conceder, alterar e revogar acesso.

A seguir

• Usar os recursos do reCAPTCHA após a migração.