为网站创建 reCAPTCHA 密钥

本页介绍了如何创建 reCAPTCHA 密钥（也称为密钥），以验证网页上的用户互动。

reCAPTCHA 密钥代表如何为网站配置 reCAPTCHA。配置包括一些重要选项，例如是否显示人机识别系统挑战。

准备工作

• 为 reCAPTCHA 准备环境。
• 确保您具有以下 Identity and Access Management 角色：reCAPTCHA Enterprise Admin (roles/recaptchaenterprise.admin)。
• 选择最适合您的应用场景的密钥类型。

创建 reCAPTCHA 密钥

您可以为一个 Google Cloud 项目创建的 reCAPTCHA 密钥的数量没有限制。最好为每个网站创建一个 reCAPTCHA 密钥。

我们建议您为预演环境和生产环境分别创建 reCAPTCHA 密钥。否则，您可能要冒着测试环境中的数据污染 reCAPTCHA 的风险来进行风险分析。

创建 reCAPTCHA 密钥的最简单方法是通过 reCAPTCHA 管理控制台。 或者，您也可以使用 Google Cloud 控制台、reCAPTCHA Enterprise API 或 Google Cloud CLI。

管理控制台

1. 前往 reCAPTCHA 管理控制台。

   前往 reCAPTCHA 管理控制台

2. 在标签字段中，输入一个可用于标识您网站的名称。
3. 如果您想创建基于得分的密钥，请选择基于得分 (v3)。如果您想创建复选框密钥，请选择基于验证方式 (v2)。
4. 如需添加网域，请输入您的域名，然后点击 。

   如需添加其他网域，您可以重复执行此步骤。您最多可以添加 250 个网域。

5. 如果您是 Google Cloud 控制台的新用户，请阅读服务条款，然后选中相应的复选框。
6. 点击提交。

如果您是 Google Cloud 控制台的新用户，系统会为您创建一个 Google Cloud 项目并启用必要的 API，以便您开始使用。如果您已有 Google Cloud 项目，则已为您的项目启用必要的 API，您可以开始使用了。

Cloud 控制台

1. 在 Google Cloud 控制台中，前往 reCAPTCHA 页面。

   前往 reCAPTCHA

2. 验证项目名称是否显示在页面顶部的项目选择器中。

   如果您没有看到项目名称，请点击资源选择器，然后选择您的项目。

3. 点击创建密钥。
4. 在显示名字段中，输入密钥的显示名。
5. 对于应用类型，选择 Web。

   系统会显示网域列表部分。

6. 为了保护您的网域和子网域的 reCAPTCHA 密钥，请确保关闭停用域名验证切换开关。

   停用域名验证是一项安全风险，因为网站不受限制，因此任何人都可以访问和使用 reCAPTCHA 密钥。

7. 输入您的网站的域名：

   1. 在网域列表部分中，点击添加网域。
   2. 在网域字段中，输入您的域名。

   3. 可选：要添加其他网域，请点击添加网域，然后在网域字段中输入其他网域的名称。 您最多可以添加 250 个网域。

      对于网站，reCAPTCHA 密钥对您指定的网域和子网域具有唯一性。如果您从多个网域传送您的网站，则可以指定多个网域。如果您指定了网域（例如 examplepetstore.com），则无需指定其子网域（例如 subdomain.examplepetstore.com）。

      如需在 250 个以上的网域中使用密钥，请点击停用网域验证切换开关。 然后，reCAPTCHA 将忽略网域列表。 您需要通过检查所创建评估中的 tokenProperties.hostname 字段自行执行域名验证。

8. 根据要为网站创建的 reCAPTCHA 密钥类型，执行适当的操作：

创建基于得分的 reCAPTCHA 密钥

注意：创建基于得分的密钥是 Google Cloud 控制台中的默认选项。

1. 如果您希望允许基于得分的密钥用于 Accelerated Mobile Pages (AMP)，请开启允许将此密钥用于 AMP 网页切换开关。

2. 对于非生产环境，如果您想指定在为密钥创建任何评估时密钥应返回的分数，请执行以下操作：

   1. 点击下一步（可选）
   2. 在“其他设置”步骤中，点击您创建此密钥是否仅用于测试目的？切换开关。
   3. 使用设置得分滑块指定介于 0 到 1.0 之间的得分。
3. 点击创建密钥。

新创建的密钥会列在 reCAPTCHA 密钥页面上。

创建复选框 reCAPTCHA 密钥

我们不推荐使用复选框密钥，因为它们会增加给用户带来的不便，且不会显著提高准确率。

1. 点击下一步（可选）。
2. 在“其他设置”步骤中，开启您是否会使用验证？ 切换。
3. 选择适当的验证安全性选项。

   验证安全性选项可控制提示用户进行二级挑战的可能性，在二级挑战中，将提示用户根据已确定的类别选择图像（例如，选择含摩托车或楼梯的图片）。

   如果您想确保最佳的反欺诈防护，请选择困难。

   如果您选择简单，用户就不太可能收到视觉挑战提示。

4. 对于非生产环境，如果您想指定在为密钥创建任何评估时密钥应返回的分数，请执行以下操作：

   1. 点击您创建此密钥是否仅用于测试目的？切换开关。
   2. 使用设置得分滑块指定介于 0 到 1.0 之间的得分。
   3. 选择适当的验证类型选项。
      • 自动有时会弹出挑战。
      • No CAPTCHA 不会显示质询。
      • 无法解决的验证问题：显示图片，但无法通过验证。
   4. 点击创建密钥。

   新创建的密钥会列在 reCAPTCHA 密钥页面上。

创建基于政策的质询 reCAPTCHA 密钥

注意：此功能目前为预览版。

1. 点击下一步（可选）。
2. 在“其他设置”步骤中，开启您是否会使用验证？ 切换。
3. 选择适当的验证安全性选项。

   “验证安全性”选项用于定义向用户显示的人机识别系统验证的复杂性和频率。

   如果您想确保最佳的反欺诈防护，请选择困难。

   如果您选择简单，用户就不太可能收到更少且更简单的人机识别系统验证提示。

4. 对于非生产环境，如果您想指定在为密钥创建任何评估时要返回的分数，请执行以下操作：

   1. 点击您创建此密钥是否仅用于测试目的？切换开关。
   2. 使用设置得分滑块指定介于 0 到 1.0 之间的得分。
5. 选择触发人机识别系统验证题目的分数阈值，该阈值适用于所有操作。
6. 点击创建密钥。

新创建的密钥会列在 reCAPTCHA 密钥页面上。

gcloud

如需创建 reCAPTCHA 密钥，请使用 gcloud recaptcha keys create 命令。

在使用下面的命令数据之前，请先进行以下替换：

• INTEGRATION_TYPE：集成类型。 根据密钥类型，指定以下值：
  • score 表示基于得分的键。
  • checkbox 表示复选框密钥。
  • policy-based-challenge 表示基于政策的验证密钥。此功能处于预览版阶段。
  注意：我们不推荐使用 CHECKBOX，因为它会增加给用户带来的不便，且不会显著提高准确率。 如需了解详情，请参阅常见问题解答。
• DISPLAY_NAME：密钥的名称。通常是网站名称。
• DOMAIN_NAME：获准使用该密钥的网站的网域或子网域。

  以英文逗号分隔的列表形式指定多个网域。

  如需在 250 个以上的网域中使用密钥，请指定 --allow-all-domains 以停用域名验证。 然后，reCAPTCHA 将忽略网域列表。 您需要通过检查所创建评估中的 tokenProperties.hostname 字段自行执行域名验证。

  停用域名验证是一项安全风险，因为网站不受限制，因此任何人都可以访问和使用 reCAPTCHA 密钥。

  注意： reCAPTCHA 密钥对您指定的网域和子网域具有唯一性。如果您从多个网域传送您的网站，则可以指定多个网域。如果您指定了网域（例如 examplepetstore.com），则无需指定其子网域（例如 subdomain.examplepetstore.com）。
• DEFAULT_SCORE_THRESHOLD：对于基于政策的验证密钥，如果未定义自定义分数阈值，此参数将定义该密钥的通用验证阈值。此功能处于预览版阶段。
• ACTION_SCORE_THRESHOLDS：对于基于政策的质询密钥，此参数用于指定操作以及介于 0.0 和 1.0 之间的相应阈值分数。例如 login='{"scoreThreshold": "0.3"}',signup='{"scoreThreshold": "0.1"}'。此功能处于预览版阶段。
  注意：评估中仅返回在完成所有挑战后计算出的最终得分。将 reCAPTCHA 计算的初始得分与阈值进行比较。

执行 gcloud recaptcha keys create 命令：

Linux、macOS 或 Cloud Shell

gcloud recaptcha keys create \
        --web \
        --display-name=DISPLAY_NAME  \
        --integration-type=INTEGRATION_TYPE \
        --domains=DOMAIN_NAME \

Windows (PowerShell)

gcloud recaptcha keys create `
        --web `
        --display-name=DISPLAY_NAME  `
        --integration-type=INTEGRATION_TYPE `
        --domains=DOMAIN_NAME `

Windows (cmd.exe)

gcloud recaptcha keys create ^
        --web ^
        --display-name=DISPLAY_NAME  ^
        --integration-type=INTEGRATION_TYPE ^
        --domains=DOMAIN_NAME ^

响应包含新创建的 reCAPTCHA 密钥。

REST

如需了解密钥类型和集成类型的 API 参考文档信息，请参阅密钥和集成类型。

在使用任何请求数据之前，请先进行以下替换：

• INTEGRATION_TYPE：集成类型。 根据密钥类型，指定以下值：
  • SCORE 表示基于得分的键。
  • CHECKBOX 表示复选框密钥。
  • POLICY_BASED_CHALLENGE 表示基于政策的验证密钥。此功能处于预览版阶段
  注意：我们不推荐使用 CHECKBOX，因为它会增加给用户带来的不便，且不会显著提高准确率。 如需了解详情，请参阅常见问题解答。
• DISPLAY_NAME：密钥的名称。通常是网站名称。
• DOMAIN_NAME：获准使用该密钥的网站的网域或子网域。

  以英文逗号分隔的列表形式指定多个网域。

  如需在 250 个以上的网域中使用密钥，请指定 --allow-all-domains 以停用域名验证。 然后，reCAPTCHA 将忽略网域列表。 您需要通过检查所创建评估中的 tokenProperties.hostname 字段自行执行域名验证。

  停用域名验证是一项安全风险，因为网站不受限制，因此任何人都可以访问和使用 reCAPTCHA 密钥。

  注意： reCAPTCHA 密钥对您指定的网域和子网域具有唯一性。如果您从多个网域传送您的网站，则可以指定多个网域。如果您指定了网域（例如 examplepetstore.com），则无需指定其子网域（例如 subdomain.examplepetstore.com）。
• DEFAULT_SCORE_THRESHOLD：对于基于政策的验证密钥，如果未定义自定义分数阈值，此参数将定义该密钥的通用验证阈值。此功能处于预览版阶段。
• ACTION_SCORE_THRESHOLDS：对于基于政策的质询密钥，此参数用于指定操作以及介于 0.0 和 1.0 之间的相应阈值分数。例如 login='{"scoreThreshold": "0.3"}',signup='{"scoreThreshold": "0.1"}'。此功能处于预览版阶段。
  注意：评估中仅返回在完成所有挑战后计算出的最终得分。将 reCAPTCHA 计算的初始得分与阈值进行比较。
• DEFAULT_SCORE_THRESHOLD：对于基于政策的验证密钥，如果未定义自定义分数阈值，此参数将定义该密钥的通用验证阈值。此功能处于预览版阶段。
• ACTION_SCORE_THRESHOLDS：对于基于政策的质询密钥，此参数用于指定操作以及介于 0.0 和 1.0 之间的相应阈值分数。例如 login='{"scoreThreshold": "0.3"}',signup='{"scoreThreshold": "0.1"}'。此功能处于预览版阶段。
  注意：评估中仅返回在完成所有挑战后计算出的最终得分。将 reCAPTCHA 计算的初始得分与阈值进行比较。

HTTP 方法和网址：

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

请求 JSON 正文：

{
  "displayName": "DISPLAY_NAME",
  "webSettings": {
    "allowedDomains": "DOMAINS",
    "integrationType": "INTEGRATION_TYPE"
  }
}

如需发送请求，请选择以下方式之一：

curl

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI，或者使用了 Cloud Shell，这会使您自动登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

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

PowerShell

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 request.json 的文件中，然后执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/project-id/keys/6Ldqgs0UAAAAAIn4k7YxEB-LwEh5S9-Gv6IIWB8m",
  "displayName": "DISPLAY_NAME",
  "webSettings": {
    "allowAllDomains": false,
    "allowedDomains": [
      DOMAINS
    ],
    "allowAmpTraffic": false,
    "integrationType": "SCORE",
    "challengeSecurityPreference": "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED"
  }
}

注意： 创建 reCAPTCHA 密钥后，您可以对其进行修改或删除。 您无法恢复已删除的密钥。此外，您无法将 reCAPTCHA 密钥从一个 Google Cloud 项目迁移到另一个 Google Cloud 项目。

（可选）查找旧版 reCAPTCHA 密钥

如果您想与未使用 reCAPTCHA Enterprise API 的第三方应用集成，则需要旧密钥。

对于您创建的每个网站密钥，reCAPTCHA 都会创建一个旧版 reCAPTCHA Secret 密钥（旧版 Secret 密钥），您可以将该密钥与第三方应用搭配使用。

如果您需要 reCAPTCHA Classic 密钥的密钥，请将该密钥迁移到 Google Cloud上的 reCAPTCHA，然后找到旧版密钥。

注意： 我们不建议在前端使用旧版密钥，因为该密钥对用户可见，攻击者可能会滥用您的应用。

如需查找旧版密钥，请执行以下操作：

1. 在 Google Cloud 控制台中，前往 reCAPTCHA 页面。

   前往 reCAPTCHA

2. 在 reCAPTCHA 密钥部分中，找到您创建的 reCAPTCHA 密钥，然后点击该密钥。

   

3. 在密钥详情页面上，点击集成标签页下的使用旧版密钥。 系统会打开一个对话框，其中包含有关如何使用旧版密钥的说明。

   

后续步骤

• 在网页上安装基于得分的密钥。
• 在网页上安装复选框密钥。
• 在网页上安装基于政策的挑战密钥。