README

reCAPTCHA是一个免费CAPTCHA服务，用于保护网站免受垃圾邮件和滥用。这是一个PHP库，用于封装处理reCAPTCHA服务响应所需的服务器端验证步骤。此客户端支持v2和v3。

• reCAPTCHA: https://www.google.com/recaptcha
• 此仓库: https://github.com/google/recaptcha
• 托管演示: https://recaptcha-demo.appspot.com/
• 版本: 1.3.0
• 许可: BSD，请参阅LICENSE

安装

Composer（推荐）

使用Composer从Packagist安装此库：google/recaptcha

从您的项目目录运行以下命令以添加依赖项

composer require google/recaptcha "^1.3"

或者，直接将依赖项添加到您的composer.json文件中

"require": {
    "google/recaptcha": "^1.3"
}

对早期版本PHP的支持

1.3版本升级到PHP 8及以上。对于早期版本，您需要继续使用1.2版本。

直接下载

下载ZIP文件并将其解压到您的项目中。在src/autoload.php中提供了一个自动加载脚本，您可以在脚本中调用它。例如

require_once '/path/to/recaptcha/src/autoload.php';
$recaptcha = new \ReCaptcha\ReCaptcha($secret);

项目中的类根据PSR-4标准组织，因此您也可以使用自己的自动加载器或在代码中直接调用所需的文件。

用法

首先在https://www.google.com/recaptcha/admin获取您希望集成的reCAPTCHA类型的适当密钥（v2）或在https://g.co/recaptcha/v3获取v3的密钥。

然后按照开发者网站上集成指南将reCAPTCHA功能添加到您的前端。

当您需要验证用户的响应时，该库就会派上用场。在PHP端，您需要从reCAPTCHA服务获取响应和您的凭证中的密钥。使用您的密钥实例化ReCaptcha类，指定任何额外的验证规则，然后使用reCAPTCHA响应（通常在$_POST['g-recaptcha-response']或JS中grecaptcha.execute()的响应，在示例中为$gRecaptchaResponse）和用户的IP地址调用verify()。例如

<?php
$recaptcha = new \ReCaptcha\ReCaptcha($secret);
$resp = $recaptcha->setExpectedHostname('recaptcha-demo.appspot.com')
                  ->verify($gRecaptchaResponse, $remoteIp);
if ($resp->isSuccess()) {
    // Verified!
} else {
    $errors = $resp->getErrorCodes();
}

以下方法可用

• setExpectedHostname($hostname)：确保主机名匹配。如果您已禁用凭证中的“域名/包名验证”，则必须这样做。
• setExpectedApkPackageName($apkPackageName)：如果您正在验证Android应用的响应。同样，如果您已禁用凭证中的“域名/包名验证”，则必须这样做。
• setExpectedAction($action)：确保v3 API中的操作匹配。
• setScoreThreshold($threshold)：为v3 API的响应设置分数阈值
• setChallengeTimeout($timeoutSeconds)：设置用户通过reCAPTCHA与您的服务器处理之间的超时时间。

set*()方法中的每一个都返回ReCaptcha实例，因此您可以链式调用它们。例如

<?php
$recaptcha = new \ReCaptcha\ReCaptcha($secret);
$resp = $recaptcha->setExpectedHostname('recaptcha-demo.appspot.com')
                  ->setExpectedAction('homepage')
                  ->setScoreThreshold(0.5)
                  ->verify($gRecaptchaResponse, $remoteIp);

if ($resp->isSuccess()) {
    // Verified!
} else {
    $errors = $resp->getErrorCodes();
}

您可以在ReCaptcha类的常量中找到库错误代码的常量，例如ReCaptcha::E_HOSTNAME_MISMATCH

有关用法和结构的更多详细信息，请参阅架构。

示例

您可以在examples/中找到每种reCAPTCHA类型的示例。您可以通过使用Composer脚本来本地运行示例

composer run-script serve-examples

这使用内置的PHP开发服务器在https://:8080/托管示例

这些示例也托管在Google AppEngine灵活环境中，网址为https://recaptcha-demo.appspot.com/。这是由app.yaml配置的，您也可以将其用于部署到您自己的AppEngine项目。

贡献

工程师永远都不够用，因此我们非常欢迎通过Pull Requests接受贡献。有关详细信息，请参阅贡献指南