Migrar do reCAPTCHA Clássico

Este documento explica como migrar uma chave de site ativa do reCAPTCHA Classic para o reCAPTCHA em um Google Cloud projeto. É possível migrar a chave de site usando o Admin Console do reCAPTCHA (recomendado) ou usando o Google Cloud console. 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 as chaves no Admin Console do reCAPTCHA, está usando o reCAPTCHA Classic. Os recursos mais recentes do reCAPTCHA só estão disponíveis para chaves de site gerenciadas em um Google Cloud projeto. Para mais informações sobre os recursos disponíveis, consulte Comparar níveis do reCAPTCHA.

As seguintes mudanças ocorrem depois que você conclui o processo de migração:

  • As chaves de site estão disponíveis em um Google Cloud projeto sem alterações.
  • A integração do reCAPTCHA continua 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 defesa de contas ou a defesa de senhas, é necessário modificar a instrumentação da página da Web e as chamadas de back-end. Para mais informações, consulte Usar recursos do reCAPTCHA após a migração.
  • Você será cobrado quando exceder a cota mensal sem custo financeiro do reCAPTCHA, que é de 10.000 avaliações por mês. Para mais informações, consulte Informações de faturamento.

Migrar usando o Admin Console do reCAPTCHA

  1. Acesse o Admin Console do reCAPTCHA.

    Acessar o Admin Console do reCAPTCHA

  2. Selecione o projeto para o qual você quer migrar as chaves.

  3. Selecione as chaves a serem migradas.

  4. Clique em Enviar.

O Google Cloud console é aberto com seu projeto e as chaves migradas.

Migrar usando o Google Cloud console

Antes de começar

  1. Noconsole, na página do seletor de projetos, escolha ou crie um Google Cloud projeto do. Google Cloud

    Papéis necessários para selecionar ou criar um projeto

    • Selecionar um projeto: a seleção de um projeto não requer um papel específico do IAM. Você pode selecionar qualquer projeto em que tenha recebido um papel.
    • Criar um projeto: para criar um projeto, você precisa do papel de criador de projetos (roles/resourcemanager.projectCreator), que contém a resourcemanager.projects.create permissão. Saiba como conceder papéis.

    Acessar o seletor de projetos

  2. Verifique se o faturamento está ativado para o Google Cloud projeto.

    O reCAPTCHA exige que o faturamento esteja 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 Google Cloud console, instale e inicialize a CLI gcloud. Para instruções, consulte

    Instale a Google Cloud CLI. Após a instalação, inicialize a Google Cloud CLI executando o seguinte comando:

    gcloud init

    Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

Ativar a API reCAPTCHA Enterprise

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

Console

  1. Noconsole, acesse a página API reCAPTCHA Enterprise. Google Cloud

    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 vir o nome do projeto, clique no seletor de projetos para selecioná-lo.

  3. Clique em Ativar.

gcloud

  1. No Google Cloud console, ative o Cloud Shell.

    Ativar o Cloud Shell

    Na parte inferior do Google Cloud console, uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a Google Cloud CLI já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

  2. Para definir o projeto na sessão da gcloud, execute o gcloud config set project comando. Google Cloud Substitua PROJECT_ID pelo Google Cloud ID do projeto.
           gcloud config set project PROJECT_ID
           
  3. Para ativar a API reCAPTCHA Enterprise, execute o gcloud services enable comando:
             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 do reCAPTCHA Classic 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 Google Cloud projeto 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 para o administrador conceder o papel ou siga as instruções em Conceder, alterar e revogar acesso.
  1. Migre a chave de site usando o Google Cloud console, a Google Cloud CLI ou a API reCAPTCHA Enterprise.

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

    Google Cloud console

    1. Noconsole, acesse a página reCAPTCHA. Google Cloud

      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 vir o nome do projeto, clique no seletor de recursos para selecioná-lo.

    3. Selecione a guia Chaves.

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

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

    CLI 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 Google Cloud projeto 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 qualquer um dos dados da solicitação, faça as seguintes substituições:

      • PROJECT_ID: o ID do Google Cloud projeto 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

      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

      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:

    Google Cloud console

    Acesse a página reCAPTCHA , selecione a guia Chaves e encontre a chave de site migrada na seção Chaves do reCAPTCHA.

    Acessar o reCAPTCHA

    CLI gcloud

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

Depois de migrar para o reCAPTCHA, você pode continuar usando o método siteverify para avaliar o token de resposta do reCAPTCHA de um usuário. Para informações sobre a resposta, consulte Resposta do siteverify method.

Depois que uma chave de site é migrada para o reCAPTCHA, o uso dela começa a ser registrado para exibição no Google Cloud console em uma hora, incluindo painéis relacionados ao uso e à pontuação. O uso antes da migração é geralmente não é exibido no Google Cloud console.

É 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