Migrer depuis reCAPTCHA Classic

Ce document explique comment migrer une clé de site active de reCAPTCHA Classic vers reCAPTCHA sur un Google Cloud projet. Vous pouvez migrer la clé de site à l'aide de la console d'administration reCAPTCHA (recommandé) ou à l'aide de laconsole Google Cloud . Le processus de migration prend 5 à 10 minutes et ne nécessite aucun changement de code.

Si vous gérez vos clés dans la console d'administration reCAPTCHA, vous utilisez reCAPTCHA Classic. Les dernières fonctionnalités de reCAPTCHA ne sont disponibles que pour les clés de site gérées dans un Google Cloud projet. Pour en savoir plus sur les fonctionnalités disponibles, consultez Comparer les niveaux reCAPTCHA.

Les modifications suivantes se produisent une fois le processus de migration terminé :

  • Vos clés de site sont disponibles dans un Google Cloud projet sans aucune modification.
  • Votre intégration reCAPTCHA existante continue de fonctionner sans nécessiter de modifications de code. Vous pouvez conserver la même instrumentation de page Web et les mêmes appels de backend. Toutefois, pour accéder à des fonctionnalités telles que Account defense ou Password defense, vous devez modifier l'instrumentation de votre page Web et les appels de backend. Pour en savoir plus, consultez Utiliser les fonctionnalités reCAPTCHA après la migration.
  • Vous serez facturé lorsque vous dépasserez le quota mensuel sans frais de reCAPTCHA, qui est de 10 000 évaluations par mois. Pour en savoir plus, consultez Informations de facturation.

Migrer à l'aide de la console d'administration reCAPTCHA

  1. Accédez à la console d'administration reCAPTCHA.

    Accéder à la console d'administration reCAPTCHA

  2. Sélectionnez le projet vers lequel vous souhaitez migrer les clés.

  3. Sélectionnez les clés à migrer.

  4. Cliquez sur Envoyer.

La Google Cloud console s'ouvre avec votre projet et les clés que vous avez migrées.

Migrer à l'aide de la Google Cloud console

Avant de commencer

  1. Dans la Google Cloud console, sur la page de sélection du projet, sélectionnez ou créez un Google Cloud projet.

    Rôles requis pour sélectionner ou créer un projet

    • Sélectionner un projet : la sélection d'un projet ne nécessite pas de rôle IAM spécifique Vous pouvez sélectionner n'importe quel projet pour lequel un rôle vous a été attribué.
    • Créer un projet : pour créer un projet, vous avez besoin du rôle Créateur de projet (roles/resourcemanager.projectCreator), qui contient l'autorisation resourcemanager.projects.create. Découvrez comment attribuer des rôles.

    Accéder au sélecteur de projet

  2. Vérifiez que la facturation est activée pour votre Google Cloud projet.

    Pour la migration, la facturation doit être associée et activée sur le projet pour reCAPTCHA. Vous pouvez activer la facturation à l'aide d'une carte de crédit ou d'un ID de compte de facturation de projet existant Google Cloud . Si vous avez besoin d'aide pour la facturation, contactez l'assistance Cloud Billing.

  3. Si vous souhaitez exécuter gcloud CLI en dehors de la Google Cloud console, installez et initialisez gcloud CLI. Pour obtenir des instructions, consultez

    Installez la Google Cloud CLI. Une fois que la Google Cloud CLI est installée, initialisezla en exécutant la commande suivante : 

    gcloud init

    Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Activer l'API reCAPTCHA Enterprise

Tous les niveaux reCAPTCHA (Essentials, Premium et Enterprise) s'exécutent sur l'API reCAPTCHA Enterprise.

Console

  1. Dans la Google Cloud console, accédez à la page API reCAPTCHA Enterprise.

    Accéder à l'API reCAPTCHA Enterprise

  2. Vérifiez que le nom de votre projet s'affiche dans le sélecteur de projet en haut de la page.

    Si le nom de votre projet n'apparaît pas, cliquez sur le sélecteur de projet, puis sélectionnez votre projet.

  3. Cliquez sur Activer.

gcloud

  1. Dans la Google Cloud console, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la fenêtre de la console, une session Cloud Shell démarre et affiche une invite de ligne de commande. Google Cloud Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  2. Pour définir votre Google Cloud projet dans la session gcloud, exécutez la gcloud config set project commande. Remplacez PROJECT_ID par l'ID de votre Google Cloud projet. 
           gcloud config set project PROJECT_ID
  3. Pour activer l'API reCAPTCHA Enterprise, exécutez la gcloud services enable commande : 
             gcloud services enable recaptchaenterprise.googleapis.com
  4. Pour vérifier que l'API reCAPTCHA Enterprise est activée, exécutez la commande gcloud services list : 
             gcloud services list --enabled

    Vérifiez que l'API reCAPTCHA Enterprise est répertoriée dans la liste des API activées.

Migrer vers reCAPTCHA

Pour migrer reCAPTCHA Classic vers reCAPTCHA, choisissez une clé de site active dans la console d'administration reCAPTCHA et migrez-la. Vous pouvez migrer une ou plusieurs clés de site actives. Toutefois, vous ne pouvez migrer qu'une seule clé de site à la fois.

Pour exécuter le processus de migration, vous devez disposer d'un compte utilisateur reCAPTCHA répondant aux exigences suivantes :

  • Dans la console d'administration reCAPTCHA, le compte utilisateur est répertorié en tant que propriétaire de la clé de site que vous souhaitez migrer.
  • Le compte utilisateur dispose de l'un des rôles IAM suivants sur le Google Cloud projet pour lequel l'API reCAPTCHA Enterprise est activée :
    • Propriétaire du projet (roles/owner)
    • Éditeur de projet (roles/editor)
    • Administrateur reCAPTCHA (roles/recaptchaenterprise.admin)
    Si votre compte utilisateur ne possède pas l'un de ces rôles, demandez à votre administrateur de l'attribuer ou suivez les instructions de la page Attribuer, modifier et révoquer des accès.

  1. Migrez la clé du site à l'aide de la Google Cloud console, de la Google Cloud CLI ou de l'API reCAPTCHA Enterprise.

    La migration de la clé de site n'affecte pas la clé ni les points de terminaison de l'API. Elle ajoute la clé à la licence Enterprise.

    Google Cloud Console

    1. Dans la Google Cloud console, accédez à la reCAPTCHA.

      Accéder à reCAPTCHA

    2. Vérifiez que le nom de votre projet s'affiche dans le sélecteur de projet en haut de la page. Si le nom de votre projet n'apparaît pas, cliquez sur le sélecteur de projet, puis sélectionnez votre projet.

    3. Dans la section Clés Classic, identifiez la clé que vous souhaitez migrer, puis cliquez sur Mettre à niveau la clé.

    4. Pour terminer la migration de la clé sélectionnée, cliquez sur Confirmer.

    gcloud CLI

    1. Pour configurer l'authentification, exécutez la commande gcloud suivante :

      gcloud auth login

      Connectez-vous avec le compte utilisateur reCAPTCHA qui possède la clé de site choisie et détient l'un des rôles suivants : Propriétaire du projet, Éditeur de projet ou Administrateur reCAPTCHA Enterprise.

    2. Choisissez et copiez une clé de site active que vous avez utilisée pour intégrer reCAPTCHA dans vos pages Web :

      1. Accédez à la console d'administration reCAPTCHA, puis cliquez sur  .

      2. Choisissez une clé de site. Les clés de site reCAPTCHA suivantes sont compatibles avec la migration : reCAPTCHA v2, Case à cocher reCAPTCHA v2, reCAPTCHA v2 Invisible et reCAPTCHA v3.

      3. Pour copier la clé de site, cliquez sur Copier la clé de site.

    3. Migrez la clé de site.

      Exécutez la commande gcloud recaptcha keys migrate comme illustré dans l'exemple suivant :

       gcloud recaptcha keys migrate SITE_KEY --project PROJECT-ID

      Indiquez les valeurs suivantes :

      • SITE_KEY : clé de site active que vous avez copiée à partir de la console d'administration reCAPTCHA.
      • PROJECT-ID : ID du Google Cloud projet pour lequel l'API reCAPTCHA Enterprise est activée.

    API REST

    1. Choisissez et copiez une clé de site active que vous avez utilisée pour intégrer reCAPTCHA dans vos pages Web :

      1. Accédez à la console d'administration reCAPTCHA, puis cliquez sur  .

      2. Choisissez une clé de site. Les clés de site reCAPTCHA suivantes sont compatibles avec la migration : reCAPTCHA v2, Case à cocher reCAPTCHA v2, reCAPTCHA v2 Invisible et reCAPTCHA v3.

      3. Pour copier la clé de site, cliquez sur Copier la clé de site.

    2. Migrez la clé de site.

      Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

      • PROJECT_ID : ID du Google Cloud projet pour lequel l'API reCAPTCHA est activée.
      • SITE_KEY : clé de site active que vous avez copiée à partir de la console d'administration reCAPTCHA.

      Méthode HTTP et URL : 

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

      Pour envoyer votre requête, choisissez l'une des options suivantes :

      curl

      Exécutez la commande suivante : 

      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

      Exécutez la commande suivante : 

      $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

      Vous devriez recevoir une réponse JSON de ce type :

      {
  "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. Pour vérifier que la clé de site a bien été migrée, procédez comme suit :

    Google Cloud Console

    Accédez à la page reCAPTCHA et recherchez la clé de site migrée dans la section Clés reCAPTCHA.

    Accéder à reCAPTCHA

    gcloud CLI

    Exécutez la commande gcloud recaptcha keys list et recherchez la clé de site migrée dans la liste des clés.

Après avoir migré vers reCAPTCHA, vous pouvez continuer à utiliser la méthode siteverify pour évaluer le jeton de réponse reCAPTCHA d'un utilisateur. Pour en savoir plus sur la réponse, consultez Réponse de la siteverify method.

Une fois qu'une clé de site est migrée vers reCAPTCHA, son utilisation commence à être enregistrée pour être affichée dans la Google Cloud console dans un délai d'une heure, y compris les tableaux de bord d'utilisation et de score. L'utilisation avant la migration n'est généralement pas affichée dans la Google Cloud console.

Vous pouvez révoquer le rôle IAM Administrateur reCAPTCHA Enterprise (roles/recaptchaenterprise.admin) de votre compte utilisateur reCAPTCHA. Pour ce faire, demandez à votre administrateur de révoquer l'accès ou suivez les instructions de la page Accorder, modifier et révoquer des accès.

Étape suivante