网络上总会有人为了一己私利,透过机器人(robot)来快速填写并送出网页上的表单,导致该网站的帐号密码被破解,或者贩卖的商品立刻被有心人士一扫而空(倒买倒卖),又或是数据库的数据在短时间内被全部爬出来。为了防范机器人来我们的网站上捣乱,最好将 Google 提供的 reCAPTCHA 真人验证机制加入网站中。

CAPTCHA 给人的感觉就是要让用户去完成艰难的图形任务,或是回答一些古怪的问题,来证明用户自己是真人。然而 Google 第三代的 reCAPTCHA 已经完全不需再让用户伤脑、伤眼睛了!第三代的 reCAPTCHA 甚至不需要用户用鼠标进行任何「勾选」或是「滑动」的动作,就可以判断用户是否为真人。

表单旁的 reCAPTCHA 标志

reCAPTCHA v3 会利用范围 0.0~1.0 的分数值来表示用户可能比较像机器人还是可能比较像真人,数值愈高愈像真人。Google 官方虽然建议将 0.5 以上的值当作真人,但实测时真人似乎都是 0.9 以上,所以为了挡掉更多像人的机器人,我们其实可以选用比 0.5 更高的数值作为门槛。

除了单纯以分数值来区分机器人与真人之外,我们也可以实作额外的商业逻辑来更进一步地验证用户的身份。例如,用户虽然用正确的帐号和密码成功登录帐号,但是他的 reCAPTCHA v3 分数值只有 0.4 或是 0.5 时,我们可以要求他去信箱收验证信才能继续登录。

此外,reCAPTCHA v3 还提供了 action 字段,可以方便我们分析访客们的行为。

reCAPTCHA v3 for Rocket Framework

「reCAPTCHA v3 for Rocket Framework」是笔者开发的套件,可以帮助开发者将 reCAPTCHA v3 加进 Rocket 应用程序中。

Crates.io

Cargo.toml

rocket-recaptcha-v3 = "*"

使用方法

注册网站并取得 reCAPTCHA v3 的两个密钥

首先来到这个页面来注册要使用 reCAPTCHA v3 的网站。

注册使用 reCAPTCHA v3 的网站

然后会得到两个密钥,请记录下来。

取得 reCAPTCHA v3 的两个密钥

将 reCAPTCHA v3 的两个密钥加进 Rocket 的设置档中

接着将刚才得到的 reCAPTCHA v3 的两个密钥,加进 Rocket 的设置档 Rocket.toml 中的 recaptcha 字段下的 v3 字段。这个 v3 字段下有一个必填字段 secret_key,即用来「创建网站和 reCAPTCHA 之间的通信」的密钥。还有一个选填字段 html_key,即「向用户显示的 HTML 代码中」使用的密钥。

举例来说:

[default.recaptcha.v3]
html_key = "6Lf6dLIUAAAAAAxghN7nH6m_yuLfHwdD3N7FpanR"
secret_key = "6Lf6dLIUAAAAAHdJ4e0nsv-8OpFH-7Oad1XQ95rq"

这个 html_key 字段主要是给开发者自己用的,可以利用 HTML 模板引擎将 html_key 字段的值填入 HTML 中。

将 reCAPTCHA v3 加入 HTML 中

预设的 reCAPTCHA v3 徽章(badge)会被浮动放置在网页的右下角,挺难看的。所以此处简单介绍用内联(inline)的方式来加入 reCAPTCHA v3 的徽章。

首先在适当的位置上加入:

<script src="https://www.recaptcha.net/recaptcha/api.js?render=explicit&onload=onReCaptchaLoadCallback" defer></script>
<script>
    function onReCaptchaLoadCallback() {
        var clientId = grecaptcha.render('inline-badge', {
            'sitekey': 'recaptcha_key',
            'badge': 'inline',
            'size': 'invisible'
        });

        grecaptcha.execute(clientId, {action: 'action_name'}).then(function (token) {
            // save the token
        });
    }
</script>

注意这边引用 JavaScript 程序时使用的网域为 www.recaptcha.net 而不是 www.google.com,这是为了让中国地区也可以使用 reCAPTCHA v3。而在其后的 JavaScript 代码中,recaptcha_key 的地方要填入 html_key 字段的值。action_name 的值则设置一个自己看得懂的名称就好了,方便用来分析数据。inline-badge 则是要用来显示 reCAPTCHA v3 徽章的元素 ID。

当 reCAPTCHA v3 运行成功后,会回传一个记号(token),要把这个 token 的值记下来,之后还要跟着表单内容一同传给我们的 Web 应用程序来验证。

将 reCAPTCHA v3 加入 Rocket 中

rocket_recaptcha_v3 这个 crate 中的 ReCaptcha 结构体,提供了 fairing 关联函数,可以回传一个整流片。这个整流片会在 Rocket 的 Ignite 阶段,读取 Rocket.toml 设置档中刚才介绍的 secret_key 和 html_key 字段,来创建 ReCaptcha 结构体的实体,并注册给 Rocket 作为应用程序状态。

use rocket_recaptcha_v3::ReCaptcha;

...

rocket::build().attach(ReCaptcha::fairing())
验证 reCAPTCHA v3 的记号

rocket_recaptcha_v3 这个 crate 中的 ReCaptchaToken 结构体,可以作为参数守卫、查找守卫或是实作了 data::FromData 特性的结构体的字段。我们可以调用 ReCaptcha 结构实体的 verify 方法,透过参数传入 ReCaptchaToken 结构实体的参考,和一个选用的 ClientRealAddr 结构实体参考,来验证用户的真人程度。

例如:

#[macro_use]
extern crate rocket;

use rocket::{form::Form, response::Redirect, State};
use rocket_recaptcha_v3::{ReCaptcha, ReCaptchaToken};

#[derive(Debug, FromForm)]
struct LoginModel {
    username:        String,
    password:        String,
    recaptcha_token: ReCaptchaToken,
}

#[post("/login", data = "<model>")]
async fn login_post(
    recaptcha: &State<ReCaptcha>,
    model: Form<LoginModel>,
) -> Result<Redirect, Redirect> {
    match recaptcha.verify(&model.recaptcha_token, None).await {
        Ok(verification) => {
            ...
        },
        Err(err) => {
            ...
        },
    }
}
验证真人

若 reCAPTCHA v3 的记号验证成功,ReCaptcha 结构实体的 verify 方法会回传一个 ReCaptchaVerification 结构实体,其 score 字段即为分数值。用 if 结构来判断分数值的高低来决定后续要做的动作。

例如:

#[post("/login", data = "<model>")]
async fn login_post(
    recaptcha: &State<ReCaptcha>,
    model: Form<LoginModel>,
) -> Result<Redirect, Redirect> {
    match recaptcha.verify(&model.recaptcha_token, None).await {
        Ok(verification) => {
            if verification.score > 0.7 {
                ...
            } else {
                ...
            }
        },
        Err(err) => {
            todo!();
        },
    }
}

完整的范例可以查看「reCAPTCHA v3 for Rocket Framework」项目中的 examples 目录。